OpenJDK 27 · javax.print.attribute.standard.JobStateReasons

Class JobStateReasons is a printing attribute class, a set of enumeration values, that provides additional information about the job's current state, i.e., information that augments the value of the job's JobState attribute.

Instances of JobStateReason do not appear in a Print Job's attribute set directly. Rather, a JobStateReasons attribute appears in the Print Job's attribute set. The JobStateReasons attribute contains zero, one, or more than one JobStateReason objects which pertain to the Print Job's status. The printer adds a JobStateReason object to the Print Job's JobStateReasons attribute when the corresponding condition becomes true of the Print Job, and the printer removes the JobStateReason object again when the corresponding condition becomes false, regardless of whether the Print Job's overall JobState also changed.

Class JobStateReasons inherits its implementation from class java.util.HashSet. Unlike most printing attributes which are immutable once constructed, class JobStateReasons is designed to be mutable; you can add JobStateReason objects to an existing JobStateReasons object and remove them again. However, like class java.util.HashSet, class JobStateReasons is not multiple thread safe. If a JobStateReasons object will be used by multiple threads, be sure to synchronize its operations (e.g., using a synchronized set view obtained from class java.util.Collections).

IPP Compatibility: The string value returned by each individual JobStateReason object's toString() method gives the IPP keyword value. The category name returned by getName() gives the IPP attribute name.

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides java.util.HashSet.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

Access	Constructor and Description
public	JobStateReasons() Construct a new, empty job state reasons attribute; the underlying hash set has the default initial capacity and load factor.
public	JobStateReasons(int initial capacity initialCapacity) Construct a new, empty job state reasons attribute; the underlying hash set has the given initial capacity and the default load factor.
public	JobStateReasons(int initial capacity initialCapacity, float load factor loadFactor) Construct a new, empty job state reasons attribute; the underlying hash set has the given initial capacity and load factor.
public	JobStateReasons(Collection<JobStateReason> collection to copy collection) Construct a new job state reasons attribute that contains the same `JobStateReason` objects as the given collection.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if this job state reasons attribute did not already contain the specified element add(JobStateReason element to be added to this job state reasons attribute o) Overrides java.util.HashSet.add. Implements java.util.Set.add, java.util.Collection.add. Adds the specified element to this job state reasons attribute if it is not already present.
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 java.util.HashSet:: clear clone contains isEmpty iterator newHashSet remove size spliterator toArray toArray

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.util.HashSet.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability. Annotations @Serial

Constructor Detail

JobStateReasons	back to summary
public JobStateReasons() Construct a new, empty job state reasons attribute; the underlying hash set has the default initial capacity and load factor.

JobStateReasons	back to summary
public JobStateReasons(int initialCapacity) Construct a new, empty job state reasons attribute; the underlying hash set has the given initial capacity and the default load factor. Parameters initialCapacity:int initial capacity Exceptions IllegalArgumentException: if the initial capacity is negative

JobStateReasons

back to summary

public JobStateReasons(int initialCapacity)

Construct a new, empty job state reasons attribute; the underlying hash set has the given initial capacity and the default load factor.

Parameters

initialCapacity:int: initial capacity

Exceptions

IllegalArgumentException:: if the initial capacity is negative

JobStateReasons	back to summary
public JobStateReasons(int initialCapacity, float loadFactor) Construct a new, empty job state reasons attribute; the underlying hash set has the given initial capacity and load factor. Parameters initialCapacity:int initial capacity loadFactor:float load factor Exceptions IllegalArgumentException: if the initial capacity is negative

JobStateReasons

back to summary

public JobStateReasons(int initialCapacity, float loadFactor)

Construct a new, empty job state reasons attribute; the underlying hash set has the given initial capacity and load factor.

Parameters

initialCapacity:int: initial capacity
loadFactor:float: load factor

Exceptions

IllegalArgumentException:: if the initial capacity is negative

JobStateReasons back to summary

JobStateReasons	back to summary
public JobStateReasons(Collection<JobStateReason> collection) Construct a new job state reasons attribute that contains the same `JobStateReason` objects as the given collection. The underlying hash set's initial capacity and load factor are as specified in the superclass constructor `HashSet(Collection)`. Parameters collection:Collection<JobStateReason> collection to copy Exceptions NullPointerException: if `collection` is `null` or if any element in `collection` is `null` ClassCastException: if any element in `collection` is not an instance of class `JobStateReason`

public JobStateReasons(Collection<JobStateReason> collection)

Construct a new job state reasons attribute that contains the same JobStateReason objects as the given collection. The underlying hash set's initial capacity and load factor are as specified in the superclass constructor HashSet(Collection).

Parameters

collection:Collection<JobStateReason>: collection to copy

Exceptions

NullPointerException:: if collection is null or if any element in collection is null
ClassCastException:: if any element in collection is not an instance of class JobStateReason

Method Detail

add back to summary

add	back to summary
public boolean add(JobStateReason o) Overrides java.util.HashSet.add. Implements java.util.Set.add, java.util.Collection.add. Adds the specified element to this job state reasons attribute if it is not already present. The element to be added must be an instance of class `JobStateReason`. If this job state reasons attribute already contains the specified element, the call leaves this job state reasons attribute unchanged and returns `false`. Parameters o:JobStateReason element to be added to this job state reasons attribute Returns:boolean `true` if this job state reasons attribute did not already contain the specified element Annotations @Override Exceptions NullPointerException: if the specified element is `null` ClassCastException: if the specified element is not an instance of class `JobStateReason` Since 1.5

public boolean add(JobStateReason o)

Overrides java.util.HashSet.add.

Implements java.util.Set.add, java.util.Collection.add.

Adds the specified element to this job state reasons attribute if it is not already present. The element to be added must be an instance of class JobStateReason. If this job state reasons attribute already contains the specified element, the call leaves this job state reasons attribute unchanged and returns false.

Parameters

o:JobStateReason: element to be added to this job state reasons attribute

Returns:boolean

true if this job state reasons attribute did not already contain the specified element

Annotations

@Override

Exceptions

NullPointerException:: if the specified element is null
ClassCastException:: if the specified element is not an instance of class JobStateReason

Since

1.5

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 `JobStateReasons`, the category is class JobStateReasons itself. Returns:Class<? extends Attribute> printing attribute class (category), an instance of class `java.lang.Class` Annotations @Override

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 JobStateReasons, the category is class JobStateReasons itself.

Returns:Class<? extends Attribute>

printing attribute class (category), an instance of class java.lang.Class

Annotations

@Override

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 JobStateReasons, the category name is `"job-state-reasons"`. Returns:String attribute category name Annotations @Override

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 JobStateReasons, the category name is "job-state-reasons".

Returns:String

attribute category name

Annotations

@Override

public final Class JobStateReasons

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail