javax.print.attribute.standard

Class PrinterStateReasons

public final class PrinterStateReasons extends HashMap<PrinterStateReason,Severity> implements PrintServiceAttribute

The PrinterStateReasons attribute provides the set of additional informations available about the current state of the printer device.

The attribute is basically a map with PrinterStateReason objects as keys associated with their severity level as Severity instances. The IPP keyword value can be constructed as follows:
reason.toString() + '-' + severity.toString()

IPP Compatibility: PrinterStateReasons is an IPP 1.1 attribute.

Constructor Summary
	PrinterStateReasons() Constructs an empty `PrinterStateReasons` attribute.
	PrinterStateReasons(int initialCapacity, float loadFactor) Constructs an empty `PrinterStateReasons` attribute with the given initial capacity and load factor.
	PrinterStateReasons(int initialCapacity) Constructs an empty `PrinterStateReasons` attribute with the given initial capacity and the default load factor.
	PrinterStateReasons(Map<PrinterStateReason,Severity> map) Constructs a `PrinterStateReasons` attribute with the given content of the map.

Method Summary
Class<? extends Attribute>	getCategory() Returns category of this class.
String	getName() Returns the name of this attribute.
Set<PrinterStateReason>	printerStateReasonSet(Severity severity) Constructs an unmodifiable view of the contained printer state reasons associated with the given severity level.
Severity	put(PrinterStateReason reason, Severity severity) Puts the given reason object associated with the given severity object into the set.

Constructor Detail

PrinterStateReasons

public PrinterStateReasons()

Constructs an empty PrinterStateReasons attribute.

PrinterStateReasons

public PrinterStateReasons(int initialCapacity, float loadFactor)

Constructs an empty PrinterStateReasons attribute with the given initial capacity and load factor.

Parameters: initialCapacity the intial capacity. loadFactor the load factor of the underlying HashMap.

Throws: IllegalArgumentException if initialCapacity < 0 IllegalArgumentException if initialCapacity or loadFactor < 0

PrinterStateReasons

public PrinterStateReasons(int initialCapacity)

Constructs an empty PrinterStateReasons attribute with the given initial capacity and the default load factor.

Parameters: initialCapacity the intial capacity.

Throws: IllegalArgumentException if initialCapacity < 0

PrinterStateReasons

public PrinterStateReasons(Map<PrinterStateReason,Severity> map)

Constructs a PrinterStateReasons attribute with the given content of the map.

Parameters: map the map for the initial values with the same PrinterStateReason to Severity mappings.

Throws: NullPointerException if map or any key/value is null. ClassCastException if values of map are not of type PrinterStateReason and keys are not of type Severity.

Method Detail

getCategory

public Class<? extends Attribute> getCategory()

Returns category of this class.

Returns: The class PrintStateReasons itself.

getName

public String getName()

Returns the name of this attribute.

Returns: The name "printer-state-reasons".

printerStateReasonSet

public Set<PrinterStateReason> printerStateReasonSet(Severity severity)

Constructs an unmodifiable view of the contained printer state reasons associated with the given severity level.

Parameters: severity the severity level for the constructed set.

Returns: The set of printer state reasons.

put

public Severity put(PrinterStateReason reason, Severity severity)

Puts the given reason object associated with the given severity object into the set.

Parameters: reason the reason of type PrinterStateReason. severity the severity of the reason of type Severity.

Returns: The previously associated severity of the reason or null if the reason object was not in the map before.

Throws: NullPointerException if any of the values is null. ClassCastException if reason is not a PrinterStateReason and severity is not a Severity instance.