FileDocCategorySizeDatePackage
JobStateReasons.javaAPI DocJava SE 6 API6536Tue Jun 10 00:26:24 BST 2008javax.print.attribute.standard

JobStateReasons

public final class JobStateReasons extends HashSet implements PrintJobAttribute
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 {@link JobState JobState} attribute.

Instances of {@link JobStateReason 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 {@link JobStateReason JobStateReason} objects which pertain to the Print Job's status. The printer adds a {@link JobStateReason JobStateReason} object to the Print Job's JobStateReasons attribute when the corresponding condition becomes true of the Print Job, and the printer removes the {@link JobStateReason JobStateReason} object again when the corresponding condition becomes false, regardless of whether the Print Job's overall {@link JobState JobState} also changed.

Class JobStateReasons inherits its implementation from class {@link java.util.HashSet java.util.HashSet}. Unlike most printing attributes which are immutable once constructed, class JobStateReasons is designed to be mutable; you can add {@link JobStateReason JobStateReason} objects to an existing JobStateReasons object and remove them again. However, like class {@link java.util.HashSet 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 {@link java.util.Collections java.util.Collections}).

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

author
Alan Kaminsky

Fields Summary
private static final long
serialVersionUID
Constructors Summary
public JobStateReasons()
Construct a new, empty job state reasons attribute; the underlying hash set has the default initial capacity and load factor.


                               
      
	super();
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.

param
initialCapacity Initial capacity.
throws
IllegalArgumentException if the initial capacity is less than zero.

	super (initialCapacity);
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.

param
initialCapacity Initial capacity.
param
loadFactor Load factor.
throws
IllegalArgumentException if the initial capacity is less than zero.

	super (initialCapacity, loadFactor);
public JobStateReasons(Collection collection)
Construct a new job state reasons attribute that contains the same {@link JobStateReason JobStateReason} objects as the given collection. The underlying hash set's initial capacity and load factor are as specified in the superclass constructor {@link java.util.HashSet#HashSet(java.util.Collection) HashSet(Collection)}.

param
collection Collection to copy.
exception
NullPointerException (unchecked exception) Thrown if collection is null or if any element in collection is null.
throws
ClassCastException (unchecked exception) Thrown if any element in collection is not an instance of class {@link JobStateReason JobStateReason}.

       super (collection);
Methods Summary
public booleanadd(javax.print.attribute.standard.JobStateReason o)
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 {@link JobStateReason JobStateReason}. If this job state reasons attribute already contains the specified element, the call leaves this job state reasons attribute unchanged and returns false.

param
o Element to be added to this job state reasons attribute.
return
true if this job state reasons attribute did not already contain the specified element.
throws
NullPointerException (unchecked exception) Thrown if the specified element is null.
throws
ClassCastException (unchecked exception) Thrown if the specified element is not an instance of class {@link JobStateReason JobStateReason}.
since
1.5

	if (o == null) {
	    throw new NullPointerException();
	}
	return super.add ((JobStateReason) o);
public final java.lang.ClassgetCategory()
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.

return
Printing attribute class (category), an instance of class {@link java.lang.Class java.lang.Class}.

	return JobStateReasons.class;
public final java.lang.StringgetName()
Get the name of the category of which this attribute value is an instance.

For class JobStateReasons, the category name is "job-state-reasons".

return
Attribute category name.

	return "job-state-reasons";