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

Instances of PrinterStateReason do not appear in a Print Service's attribute set directly. Rather, a PrinterStateReasons attribute appears in the Print Service's attribute set. The PrinterStateReasons attribute contains zero, one, or more than one PrinterStateReason objects which pertain to the Print Service's status, and each PrinterStateReason object is associated with a Severity level of REPORT (least severe), WARNING, or ERROR (most severe). The printer adds a PrinterStateReason object to the Print Service's PrinterStateReasons attribute when the corresponding condition becomes true of the printer, and the printer removes the PrinterStateReason object again when the corresponding condition becomes false, regardless of whether the Print Service's overall PrinterState also changed.

Class PrinterStateReasons inherits its implementation from class java.util.HashMap. Each entry in the map consists of a PrinterStateReason object (key) mapping to a Severity object (value):

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

IPP Compatibility: The string values returned by each individual PrinterStateReason object's and the associated Severity object's toString() methods, concatenated together with a hyphen ("-") in between, gives the IPP keyword value. The category name returned by getName() gives the IPP attribute name.

Modifier and Type	Class and Description
private static class	PrinterStateReasons.PrinterStateReasonSet
private static class	PrinterStateReasons.PrinterStateReasonSetIterator

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

Constructor Summary

Access	Constructor and Description
public	PrinterStateReasons() Construct a new, empty printer state reasons attribute; the underlying hash map has the default initial capacity and load factor.
public	PrinterStateReasons(int initial capacity initialCapacity) Construct a new, empty printer state reasons attribute; the underlying hash map has the given initial capacity and the default load factor.
public	PrinterStateReasons(int initial capacity initialCapacity, float load factor loadFactor) Construct a new, empty printer state reasons attribute; the underlying hash map has the given initial capacity and load factor.
public	PrinterStateReasons(Map<PrinterStateReason, Severity> map to copy map) Construct a new printer state reasons attribute that contains the same `PrinterStateReason`-to-`Severity` mappings as the given map.

Method Summary

Modifier and Type	Method and Description
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.
public Set<PrinterStateReason>	Returns: set view of the individual `PrinterStateReason` attributes at the given `Severity` level printerStateReasonSet(Severity severity level severity) Obtain an unmodifiable set view of the individual printer state reason attributes at the given severity level in this `PrinterStateReasons` attribute.
public Severity	Returns: previous severity associated with the given printer state reason, or `null` if the given printer state reason was not present put(PrinterStateReason printer state reason. This must be an instance of class `PrinterStateReason` reason, Severity severity of the printer state reason. This must be an instance of class `Severity` severity) Overrides java.util.HashMap.put. Implements java.util.Map.put. Adds the given printer state reason to this printer state reasons attribute, associating it with the given severity level.

Field Detail

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

serialVersionUID

back to summary

private static final long serialVersionUID

Hides java.util.HashMap.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations

@Serial

Constructor Detail

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

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

PrinterStateReasons

back to summary

public PrinterStateReasons(int initialCapacity)

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

Parameters

initialCapacity:int: initial capacity

Exceptions

IllegalArgumentException:: if the initial capacity is negative

PrinterStateReasons	back to summary
public PrinterStateReasons(int initialCapacity, float loadFactor) Construct a new, empty printer state reasons attribute; the underlying hash map 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

PrinterStateReasons

back to summary

public PrinterStateReasons(int initialCapacity, float loadFactor)

Construct a new, empty printer state reasons attribute; the underlying hash map 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

PrinterStateReasons back to summary

PrinterStateReasons	back to summary
public PrinterStateReasons(Map<PrinterStateReason, Severity> map) Construct a new printer state reasons attribute that contains the same `PrinterStateReason`-to-`Severity` mappings as the given map. The underlying hash map's initial capacity and load factor are as specified in the superclass constructor `HashMap(Map)`. Parameters map:Map<PrinterStateReason, Severity> map to copy Exceptions NullPointerException: if `map` is `null` or if any key or value in `map` is `null` ClassCastException: if any key in `map` is not an instance of class `PrinterStateReason` or if any value in `map` is not an instance of class `Severity`

public PrinterStateReasons(Map<PrinterStateReason, Severity> map)

Construct a new printer state reasons attribute that contains the same PrinterStateReason-to-Severity mappings as the given map. The underlying hash map's initial capacity and load factor are as specified in the superclass constructor HashMap(Map).

Parameters

map:Map<PrinterStateReason, Severity>: map to copy

Exceptions

NullPointerException:: if map is null or if any key or value in map is null
ClassCastException:: if any key in map is not an instance of class PrinterStateReason or if any value in map is not an instance of class Severity

Method Detail

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 `PrinterStateReasons`, the category is class `PrinterStateReasons` 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 PrinterStateReasons, the category is class PrinterStateReasons 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 `PrinterStateReasons`, the category name is `"printer-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 PrinterStateReasons, the category name is "printer-state-reasons".

Returns:String

attribute category name

Annotations

@Override

printerStateReasonSet back to summary

printerStateReasonSet	back to summary
public Set<PrinterStateReason> printerStateReasonSet(Severity severity) Obtain an unmodifiable set view of the individual printer state reason attributes at the given severity level in this `PrinterStateReasons` attribute. Each element in the set view is a `PrinterStateReason` object. The only elements in the set view are the `PrinterStateReason` objects that map to the given severity value. The set view is backed by this `PrinterStateReasons` attribute, so changes to this `PrinterStateReasons` attribute are reflected in the set view. The set view does not support element insertion or removal. The set view's iterator does not support element removal. Parameters severity:Severity severity level Returns:Set<PrinterStateReason> set view of the individual `PrinterStateReason` attributes at the given `Severity` level Exceptions NullPointerException: if `severity` is `null`

public Set<PrinterStateReason> printerStateReasonSet(Severity severity)

Obtain an unmodifiable set view of the individual printer state reason attributes at the given severity level in this PrinterStateReasons attribute. Each element in the set view is a PrinterStateReason object. The only elements in the set view are the PrinterStateReason objects that map to the given severity value. The set view is backed by this PrinterStateReasons attribute, so changes to this PrinterStateReasons attribute are reflected in the set view. The set view does not support element insertion or removal. The set view's iterator does not support element removal.

Parameters

severity:Severity: severity level

Returns:Set<PrinterStateReason>

set view of the individual PrinterStateReason attributes at the given Severity level

Exceptions

NullPointerException:: if severity is null

put back to summary

put	back to summary
public Severity put(PrinterStateReason reason, Severity severity) Overrides java.util.HashMap.put. Implements java.util.Map.put. Adds the given printer state reason to this printer state reasons attribute, associating it with the given severity level. If this printer state reasons attribute previously contained a mapping for the given printer state reason, the old value is replaced. Parameters reason:PrinterStateReason printer state reason. This must be an instance of class `PrinterStateReason` severity:Severity severity of the printer state reason. This must be an instance of class `Severity` Returns:Severity previous severity associated with the given printer state reason, or `null` if the given printer state reason was not present Annotations @Override Exceptions NullPointerException: if `reason` is `null` or `severity` is `null` ClassCastException: if `reason` is not an instance of class `PrinterStateReason` or if `severity` is not an instance of class `Severity` Since 1.5

public Severity put(PrinterStateReason reason, Severity severity)

Overrides java.util.HashMap.put.

Implements java.util.Map.put.

Adds the given printer state reason to this printer state reasons attribute, associating it with the given severity level. If this printer state reasons attribute previously contained a mapping for the given printer state reason, the old value is replaced.

Parameters

reason:PrinterStateReason: printer state reason. This must be an instance of class PrinterStateReason
severity:Severity: severity of the printer state reason. This must be an instance of class Severity

Returns:Severity

previous severity associated with the given printer state reason, or null if the given printer state reason was not present

Annotations

@Override

Exceptions

NullPointerException:: if reason is null or severity is null
ClassCastException:: if reason is not an instance of class PrinterStateReason or if severity is not an instance of class Severity

Since

1.5

javax.print.attribute.standard back to summary

private Class PrinterStateReasons.PrinterStateReasonSet

Class Inheritance

extends AbstractSet<PrinterStateReason>

java.lang.Object
java.util.AbstractCollection
java.util.AbstractSet
javax.print.attribute.standard.PrinterStateReasons.PrinterStateReasonSet

Field Summary

Modifier and Type	Field and Description
private Set<Map.Entry<PrinterStateReason, Severity>>	myEntrySet
private Severity	mySeverity

Constructor Summary

Access	Constructor and Description
public	PrinterStateReasonSet(Severity severity, Set<Map.Entry<PrinterStateReason, Severity>> entrySet)

Method Summary

Modifier and Type	Method and Description
public Iterator<PrinterStateReason>	iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Set.iterator, java.util.Collection.iterator. Returns an iterator over the elements in this set.
public int	size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Set.size, java.util.Collection.size. Returns the number of elements in this set (its cardinality).

Inherited from java.util.AbstractSet:: equals hashCode removeAll

Field Detail

myEntrySet	back to summary
private Set<Map.Entry<PrinterStateReason, Severity>> myEntrySet

mySeverity	back to summary
private Severity mySeverity

Constructor Detail

PrinterStateReasonSet	back to summary
public PrinterStateReasonSet(Severity severity, Set<Map.Entry<PrinterStateReason, Severity>> entrySet)

Method Detail

iterator	back to summary
public Iterator<PrinterStateReason> iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Set.iterator, java.util.Collection.iterator. Doc from java.util.Set.iterator. Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee). Annotations @Override

iterator

back to summary

public Iterator<PrinterStateReason> iterator()

Implements abstract java.util.AbstractCollection.iterator.

Implements java.util.Set.iterator, java.util.Collection.iterator.

Doc from java.util.Set.iterator.

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

Annotations

@Override

size back to summary

size	back to summary
public int size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Set.size, java.util.Collection.size. Doc from java.util.Set.size. Returns the number of elements in this set (its cardinality). If this set contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`. Annotations @Override

public int size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.Set.size, java.util.Collection.size.

Doc from java.util.Set.size.

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Annotations

@Override

javax.print.attribute.standard back to summary

private Class PrinterStateReasons.PrinterStateReasonSetIterator

Class Inheritance

extends Object
implements Iterator<PrinterStateReason>

java.lang.Object
javax.print.attribute.standard.PrinterStateReasons.PrinterStateReasonSetIterator

All Implemented Interfaces

java.util.Iterator

Field Summary

Modifier and Type	Field and Description
private Map.Entry<PrinterStateReason, Severity>	myEntry
private Iterator<Map.Entry<PrinterStateReason, Severity>>	myIterator
private Severity	mySeverity

Constructor Summary

Access	Constructor and Description
public	PrinterStateReasonSetIterator(Severity severity, Iterator<Map.Entry<PrinterStateReason, Severity>> iterator)

Method Summary

Modifier and Type	Method and Description
private void	goToNext()
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public PrinterStateReason	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

myEntry	back to summary
private Map.Entry<PrinterStateReason, Severity> myEntry

myIterator	back to summary
private Iterator<Map.Entry<PrinterStateReason, Severity>> myIterator

mySeverity	back to summary
private Severity mySeverity

Constructor Detail

PrinterStateReasonSetIterator	back to summary
public PrinterStateReasonSetIterator(Severity severity, Iterator<Map.Entry<PrinterStateReason, Severity>> iterator)

Method Detail

goToNext	back to summary
private void goToNext()

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Annotations

@Override

next	back to summary
public PrinterStateReason next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Annotations @Override

back to summary

public PrinterStateReason next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Annotations

@Override

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override

public final Class PrinterStateReasons

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PrinterStateReasons.PrinterStateReasonSet

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PrinterStateReasons.PrinterStateReasonSetIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail