PrinterStateReasons JDK 1.6)

Description

publicfinal class PrinterStateReasons

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 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).

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.

See also:

Methods

Hide/Show inherited methods

public void clear () [Inherited From HashMap]

Removes all of the mappings from this map.

public Object clone () [Inherited From HashMap]

Returns a shallow copy of this HashMap instance: the keys and values themselves are not cloned.

public boolean containsKey (Object key) [Inherited From HashMap]

Returns true if this map contains a mapping for the specified key.

public boolean containsValue (Object value) [Inherited From HashMap]

Returns true if this map maps one or more keys to the specified value.

public Set<Entry< K, V>> entrySet () [Inherited From HashMap] [Specified in AbstractMap]

Returns a Set view of the mappings contained in this map.

public boolean equals (Object o) [Inherited From AbstractMap]

Compares the specified object with this map for equality.

public V get (Object key) [Inherited From HashMap]

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

A return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.
See Also: HashMap.put(Object, Object),

publicfinal Class<Attribute> getCategory ()

Get the printing attribute class which is to be used as the "category" for this printing attribute value.

publicfinal String getName ()

Get the name of the category of which this attribute value is an instance.

public int hashCode () [Inherited From AbstractMap]

Returns the hash code value for this map.

public boolean isEmpty () [Inherited From HashMap]

Returns true if this map contains no key-value mappings.

public Set< K> keySet () [Inherited From HashMap]

Returns a Set view of the keys contained in this map.

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.

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.
Returns: Set view of the individual {@link PrinterStateReason PrinterStateReason} attributes at the given {@link Severity Severity} level.
Parameters:
- severity - Severity level.
Throws:
- NullPointerException - (unchecked exception) Thrown if severity is null.

public V put ( K key, V value) [Inherited From HashMap]

Associates the specified value with the specified key in this map.

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.

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.
Returns: Previous severity associated with the given printer state reason, or null if the given printer state reason was not present.
Parameters:
- reason - Printer state reason. This must be an instance of class {@link PrinterStateReason PrinterStateReason}.
- severity - Severity of the printer state reason. This must be an instance of class {@link Severity Severity}.
Throws:
- NullPointerException - (unchecked exception) Thrown if reason is null or severity is null.
- ClassCastException - (unchecked exception) Thrown if reason is not an instance of class {@link PrinterStateReason PrinterStateReason} or if severity is not an instance of class {@link Severity Severity}.
Since: 1.5

public void putAll (Map<Object, Object> m) [Inherited From HashMap]

Copies all of the mappings from the specified map to this map.

public V remove (Object key) [Inherited From HashMap]

Removes the mapping for the specified key from this map if present.

public int size () [Inherited From HashMap]

Returns the number of key-value mappings in this map.

public String toString () [Inherited From AbstractMap]

Returns a string representation of this map.

public Collection< V> values () [Inherited From HashMap]

Returns a Collection view of the values contained in this map.