Serializable, Cloneable, Iterable<JobStateReason>, Collection<JobStateReason>, Set<JobStateReason>, Attribute, PrintJobAttribute
public final class JobStateReasons extends HashSet<JobStateReason> implements PrintJobAttribute
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.
| Constructor | Description |
|---|---|
JobStateReasons() |
Construct a new, empty job state reasons attribute; the underlying hash set has the default initial capacity and load factor. |
JobStateReasons |
Construct a new, empty job state reasons attribute; the underlying hash set has the given initial capacity and the default load factor. |
JobStateReasons |
Construct a new, empty job state reasons attribute; the underlying hash set has the given initial capacity and load factor. |
JobStateReasons |
Construct a new job state reasons attribute that contains the same JobStateReason objects as the given collection. |
| Modifier and Type | Method | Description |
|---|---|---|
boolean |
add |
Adds the specified element to this job state reasons attribute if it is not already present. |
final Class |
getCategory() |
Get the printing attribute class which is to be used as the "category" for this printing attribute value. |
final String |
getName() |
Get the name of the category of which this attribute value is an instance. |
clear, clone, contains, isEmpty, iterator, newHashSet, remove, size, spliterator, toArray, toArray
equals, hashCode, removeAll
addAll, containsAll, retainAll, toArray, toArray, toString
parallelStream, removeIf, stream, toArray
public JobStateReasons()
public JobStateReasons(int initialCapacity)
initialCapacity - initial capacityIllegalArgumentException - if the initial capacity is negativepublic JobStateReasons(int initialCapacity, float loadFactor)
initialCapacity - initial capacityloadFactor - load factorIllegalArgumentException - if the initial capacity is negativepublic JobStateReasons(Collection<JobStateReason> collection)
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).collection - collection to copyNullPointerException - 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 boolean add(JobStateReason o)
JobStateReason. If this job state reasons attribute already contains the specified element, the call leaves this job state reasons attribute unchanged and returns false.add in interface Collection<JobStateReason>
add in interface Set<JobStateReason>
add in class HashSet<JobStateReason>
o - element to be added to this job state reasons attributetrue if this job state reasons attribute did not already contain the specified elementNullPointerException - if the specified element is null
ClassCastException - if the specified element is not an instance of class JobStateReason
public final Class<? extends Attribute> getCategory()
For class JobStateReasons, the category is class JobStateReasons itself.
getCategory in interface Attribute
java.lang.Class
public final String getName()
For class JobStateReasons, the category name is "job-state-reasons".
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/print/attribute/standard/JobStateReasons.html