OpenJDK 1.23 · javax.print.attribute.standard.JobPriority

Class JobPriority is an integer valued printing attribute class that specifies a print job's priority.

If a JobPriority attribute is specified for a Print Job, it specifies a priority for scheduling the job. A higher value specifies a higher priority. The value 1 indicates the lowest possible priority. The value 100 indicates the highest possible priority. Among those jobs that are ready to print, a printer must print all jobs with a priority value of n before printing those with a priority value of n-1 for all n.

If the client does not specify a JobPriority attribute for a Print Job and the printer does support the JobPriority attribute, the printer must use an implementation-defined default JobPriority value.

The client can always specify any job priority value from 1 to 100 for a job. However, a Print Service instance may support fewer than 100 different job priority levels. If this is the case, the Print Service instance automatically maps the client-specified job priority value to one of the supported job priority levels, dividing the 100 job priority values equally among the available job priority levels.

IPP Compatibility: The integer value gives the IPP integer value. The category name returned by getName() gives the IPP attribute name.

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides javax.print.attribute.IntegerSyntax.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

Access	Constructor and Description
public	JobPriority(int Integer value value) Construct a new job priority attribute with the given integer value.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if `object` is equivalent to this job priority attribute, `false` otherwise equals(Object `Object` to compare to object) Overrides javax.print.attribute.IntegerSyntax.equals. Returns whether this job priority attribute is equivalent to the passed in object.
public final Class<? extends Attribute>	Returns: printing attribute class (category), an instance of class `java.lang.Class` getCategory() Implements javax.print.attribute.Attribute.getCategory. Get the printing attribute class which is to be used as the "category" for this printing attribute value.
public final String	Returns: attribute category name getName() Implements javax.print.attribute.Attribute.getName. Get the name of the category of which this attribute value is an instance.

Inherited from javax.print.attribute.IntegerSyntax:: getValue hashCode toString

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides javax.print.attribute.IntegerSyntax.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability. Annotations @Serial

serialVersionUID

back to summary

private static final long serialVersionUID

Hides javax.print.attribute.IntegerSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations

@Serial

Constructor Detail

JobPriority back to summary

JobPriority	back to summary
public JobPriority(int value) Construct a new job priority attribute with the given integer value. Parameters value:int Integer value Exceptions IllegalArgumentException: if `value` is less than 1 or greater than 100

public JobPriority(int value)

Construct a new job priority attribute with the given integer value.

Parameters

value:int: Integer value

Exceptions

IllegalArgumentException:: if value is less than 1 or greater than 100

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides javax.print.attribute.IntegerSyntax.equals. Returns whether this job priority attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true: `object` is not `null`. `object` is an instance of class `JobPriority`. This job priority attribute's value and `object`'s value are equal. Parameters object:Object `Object` to compare to Returns:boolean `true` if `object` is equivalent to this job priority attribute, `false` otherwise

public boolean equals(Object object)

Overrides javax.print.attribute.IntegerSyntax.equals.

Returns whether this job priority attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:

object is not null.
object is an instance of class JobPriority.
This job priority attribute's value and object's value are equal.

Parameters

object:Object: Object to compare to

Returns:boolean

true if object is equivalent to this job priority attribute, false otherwise

getCategory back to summary

getCategory	back to summary
public final Class<? extends Attribute> getCategory() Implements javax.print.attribute.Attribute.getCategory. Get the printing attribute class which is to be used as the "category" for this printing attribute value. For class `JobPriority`, the category is class `JobPriority` itself. Returns:Class<? extends Attribute> printing attribute class (category), an instance of class `java.lang.Class`

public final Class<? extends Attribute> getCategory()

Implements javax.print.attribute.Attribute.getCategory.

Get the printing attribute class which is to be used as the "category" for this printing attribute value.

For class JobPriority, the category is class JobPriority itself.

Returns:Class<? extends Attribute>: printing attribute class (category), an instance of class java.lang.Class

getName back to summary

getName	back to summary
public final String getName() Implements javax.print.attribute.Attribute.getName. Get the name of the category of which this attribute value is an instance. For class `JobPriority`, the category name is `"job-priority"`. Returns:String attribute category name

public final String getName()

Implements javax.print.attribute.Attribute.getName.

Get the name of the category of which this attribute value is an instance.

For class JobPriority, the category name is "job-priority".

Returns:String: attribute category name

public final Class JobPriority

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail