| javax.print.attribute.standard.PrinterStateReasons
| PrinterStateReasons | | final public class PrinterStateReasons extends HashMap implements PrintServiceAttribute(Code) | | 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 PrinterState attribute.
Instances of
PrinterStateReason 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 PrinterStateReason objects which pertain to the Print
Service's status, and each
PrinterStateReason PrinterStateReason
object is associated with a
Severity Severity level of REPORT
(least severe), WARNING, or ERROR (most severe). The printer adds a
PrinterStateReason PrinterStateReason object to the Print Service's
PrinterStateReasons attribute when the corresponding condition becomes true
of the printer, and the printer removes the
PrinterStateReason PrinterStateReason object again when the corresponding condition becomes
false, regardless of whether the Print Service's overall
PrinterState PrinterState also changed.
Class PrinterStateReasons inherits its implementation from class
java.util.HashMap java.util.HashMap . Each entry in the map consists of a
PrinterStateReason PrinterStateReason object (key) mapping to a
Severity Severity object (value):
Unlike most printing attributes which are immutable once constructed, class
PrinterStateReasons is designed to be mutable; you can add
PrinterStateReason PrinterStateReason objects to an existing
PrinterStateReasons object and remove them again. However, like class
java.util.HashMap java.util.HashMap , class PrinterStateReasons is
bot 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 java.util.Collections ).
IPP Compatibility: The string values returned by each individual
PrinterStateReason PrinterStateReason object's and the associated
Severity 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.
author:
Alan Kaminsky |
| Constructor Summary | |
| 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 initialCapacity)
super a new, empty printer state reasons attribute; the underlying
hash map has the given initial capacity and the default load factor. | | 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. | | public | PrinterStateReasons(Map<PrinterStateReason, Severity> map)
Construct a new printer state reasons attribute that contains the same
PrinterStateReason PrinterStateReason -to-
Severity Severity mappings as the given map. |
| Method Summary | |
| final public Class<? extends 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. | | final public String | getName()
Get the name of the category of which this attribute value is an
instance. | | 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. | | public Severity | put(PrinterStateReason reason, Severity severity)
Adds the given printer state reason to this printer state reasons
attribute, associating it with the given severity level. |
| PrinterStateReasons | | public PrinterStateReasons()(Code) | | Construct a new, empty printer state reasons attribute; the underlying
hash map has the default initial capacity and load factor.
|
| PrinterStateReasons | | public PrinterStateReasons(int initialCapacity)(Code) | | super a new, empty printer state reasons attribute; the underlying
hash map has the given initial capacity and the default load factor.
Parameters:
initialCapacity - Initial capacity.
throws:
IllegalArgumentException - if the initial capacity is less than zero. |
| PrinterStateReasons | | public PrinterStateReasons(int initialCapacity, float loadFactor)(Code) | | Construct a new, empty printer state reasons attribute; the underlying
hash map has the given initial capacity and load factor.
Parameters:
initialCapacity - Initial capacity.
Parameters:
loadFactor - Load factor.
throws:
IllegalArgumentException - if the initial capacity is less than zero. |
| getCategory | | final public Class<? extends Attribute> getCategory()(Code) | | 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.
Printing attribute class (category), an instance of classjava.lang.Class java.lang.Class. |
| getName | | final public String getName()(Code) | | Get the name of the category of which this attribute value is an
instance.
For class PrinterStateReasons, the
category name is "printer-state-reasons".
Attribute category name. |
| printerStateReasonSet | | public Set<PrinterStateReason> printerStateReasonSet(Severity severity)(Code) | | 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 PrinterStateReason object. The only elements in the set view are the
PrinterStateReason 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 level. Set view of the individual PrinterStateReasonPrinterStateReason attributes at the given Severity Severity level.
exception:
NullPointerException - (unchecked exception) Thrown if severity is null. |
| put | | public Severity put(PrinterStateReason reason, Severity severity)(Code) | | 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 - Printer state reason. This must be an instance ofclass PrinterStateReason PrinterStateReason.
Parameters:
severity - Severity of the printer state reason. This must bean instance of class Severity Severity. Previous severity associated with the given printer statereason, or null if the given printer state reason was not present.
throws:
NullPointerException - (unchecked exception) Thrown if reason is null or severity is null.
throws:
ClassCastException - (unchecked exception) Thrown if reason is not an instance of class PrinterStateReason PrinterStateReason or if severity is not an instance of class Severity Severity.
since:
1.5 |
|
|