Summary: Ctors | Methods | Inherited Methods | [Expand All]

public final class

PrinterStateReasons

extends HashMap<K, V>
implements PrintServiceAttribute

java.lang.Object
↳	java.util.AbstractMap<K, V>
	↳	java.util.HashMap<K, V>
		↳	javax.print.attribute.standard.PrinterStateReasons

Class Overview

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.

Summary

Public Constructors
	PrinterStateReasons() Construct a new, empty printer state reasons attribute; the underlying hash map has the default initial capacity and load factor.
	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.
	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.
	PrinterStateReasons(Map<PrinterStateReason, Severity> map) Construct a new printer state reasons attribute that contains the same `PrinterStateReason`-to-`Severity` mappings as the given map.

Public Methods
final Class<? extends Attribute>	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.
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.
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.

[Expand]

Inherited Methods

From class java.util.HashMap

void	clear() Removes all of the mappings from this map.
Object	clone() Returns a shallow copy of this `HashMap` instance: the keys and values themselves are not cloned.
boolean	containsKey(Object key) Returns `true` if this map contains a mapping for the specified key.
boolean	containsValue(Object value) Returns `true` if this map maps one or more keys to the specified value.
Set<Entry<K, V>>	entrySet() Returns a `Set` view of the mappings contained in this map.
V	get(Object key) Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
boolean	isEmpty() Returns `true` if this map contains no key-value mappings.
Set<K>	keySet() Returns a `Set` view of the keys contained in this map.
V	put(K key, V value) Associates the specified value with the specified key in this map.
void	putAll(Map<? extends K, ? extends V> m) Copies all of the mappings from the specified map to this map.
V	remove(Object key) Removes the mapping for the specified key from this map if present.
int	size() Returns the number of key-value mappings in this map.
Collection<V>	values() Returns a `Collection` view of the values contained in this map.

From class java.util.AbstractMap

void	clear() Removes all of the mappings from this map (optional operation). This implementation calls `entrySet().clear()`.
Object	clone() Returns a shallow copy of this `AbstractMap` instance: the keys and values themselves are not cloned.
boolean	containsKey(Object key) Returns `true` if this map contains a mapping for the specified key. This implementation iterates over `entrySet()` searching for an entry with the specified key.
boolean	containsValue(Object value) Returns `true` if this map maps one or more keys to the specified value. This implementation iterates over `entrySet()` searching for an entry with the specified value.
abstract Set<Entry<K, V>>	entrySet() Returns a `Set` view of the mappings contained in this map.
boolean	equals(Object o) Compares the specified object with this map for equality.
V	get(Object key) Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key. This implementation iterates over `entrySet()` searching for an entry with the specified key.
int	hashCode() Returns the hash code value for this map.
boolean	isEmpty() Returns `true` if this map contains no key-value mappings. This implementation returns `size() == 0`.
Set<K>	keySet() Returns a `Set` view of the keys contained in this map. This implementation returns a set that subclasses `AbstractSet`.
V	put(K key, V value) Associates the specified value with the specified key in this map (optional operation). This implementation always throws an `UnsupportedOperationException`.
void	putAll(Map<? extends K, ? extends V> m) Copies all of the mappings from the specified map to this map (optional operation). This implementation iterates over the specified map's `entrySet()` collection, and calls this map's `put` operation once for each entry returned by the iteration.
V	remove(Object key) Removes the mapping for a key from this map if it is present (optional operation). This implementation iterates over `entrySet()` searching for an entry with the specified key.
int	size() Returns the number of key-value mappings in this map. This implementation returns `entrySet().size()`.
String	toString() Returns a string representation of this map.
Collection<V>	values() Returns a `Collection` view of the values contained in this map. This implementation returns a collection that subclasses `AbstractCollection`.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface java.util.Map

abstract void	clear() Removes all of the mappings from this map (optional operation).
abstract boolean	containsKey(Object key) Returns `true` if this map contains a mapping for the specified key.
abstract boolean	containsValue(Object value) Returns `true` if this map maps one or more keys to the specified value.
abstract Set<Entry<K, V>>	entrySet() Returns a `Set` view of the mappings contained in this map.
abstract boolean	equals(Object o) Compares the specified object with this map for equality.
abstract V	get(Object key) Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
abstract int	hashCode() Returns the hash code value for this map.
abstract boolean	isEmpty() Returns `true` if this map contains no key-value mappings.
abstract Set<K>	keySet() Returns a `Set` view of the keys contained in this map.
abstract V	put(K key, V value) Associates the specified value with the specified key in this map (optional operation).
abstract void	putAll(Map<? extends K, ? extends V> m) Copies all of the mappings from the specified map to this map (optional operation).
abstract V	remove(Object key) Removes the mapping for a key from this map if it is present (optional operation).
abstract int	size() Returns the number of key-value mappings in this map.
abstract Collection<V>	values() Returns a `Collection` view of the values contained in this map.

From interface javax.print.attribute.Attribute

Public Constructors

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.

Parameters

initialCapacity	Initial capacity.

Throws

IllegalArgumentException	if the initial capacity is less than zero.

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	Initial capacity.
loadFactor	Load factor.

Throws

IllegalArgumentException	if the initial capacity is less than zero.

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 to copy.

Throws

NullPointerException	(unchecked exception) Thrown if `map` is null or if any key or value in `map` is null.
ClassCastException	(unchecked exception) Thrown 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 Methods

public final 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.

Returns

Printing attribute class (category), an instance of class java.lang.Class.

public final String 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

Attribute category name.

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

Returns

Set view of the individual PrinterStateReason attributes at the given Severity level.

Throws

NullPointerException	(unchecked exception) Thrown if `severity` is null.

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. 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 of class `PrinterStateReason`.
severity	Severity of the printer state reason. This must be an instance of class `Severity`.

Returns

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

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 `PrinterStateReason` or if `severity` is not an instance of class `Severity`.

Classes

PrinterStateReasons

Class Overview

Summary

Public Constructors

public PrinterStateReasons ()

public PrinterStateReasons (int initialCapacity)

Parameters

Throws

public PrinterStateReasons (int initialCapacity, float loadFactor)

Parameters

Throws

public PrinterStateReasons (Map<PrinterStateReason, Severity> map)

Parameters

Throws

Public Methods

public final Class<? extends Attribute> getCategory ()

Returns

public final String getName ()

Returns

public Set<PrinterStateReason> printerStateReasonSet (Severity severity)

Parameters

Returns

Throws

public Severity put (PrinterStateReason reason, Severity severity)

Parameters

Returns

Throws