Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.print.attribute.standard

Class PrinterStateReasons

Implemented Interfaces:
Attribute, Cloneable, Map<K,V>, PrintServiceAttribute, Serializable
public final class PrinterStateReasons
extends HashMap<K,V>
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.

See Also:
PrinterState, PrinterStateReason, Severity, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap<K,V>

AbstractMap.SimpleEntry, AbstractMap.SimpleImmutableEntry

Constructor Summary

PrinterStateReasons()
Constructs an empty PrinterStateReasons attribute.
PrinterStateReasons(Map map)
Constructs a PrinterStateReasons attribute with the given content of the map.
PrinterStateReasons(int initialCapacity)
Constructs an empty PrinterStateReasons attribute with the given initial capacity and the default load factor.
PrinterStateReasons(int initialCapacity, float loadFactor)
Constructs an empty PrinterStateReasons attribute with the given initial capacity and load factor.

Method Summary

Class<
? extends Attribute> getCategory()
Returns category of this class.
String
getName()
Returns the name of this attribute.
Set
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.

Methods inherited from class java.util.HashMap<K,V>

V>> entrySet, clear, clone, containsKey, containsValue, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap<K,V>

V>> entrySet, clear, clone, containsKey, containsValue, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PrinterStateReasons

public PrinterStateReasons()
Constructs an empty PrinterStateReasons attribute.

PrinterStateReasons

public PrinterStateReasons(Map 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.

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(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

Method Details

? extends Attribute> getCategory

public Class< ? extends Attribute> getCategory()
Returns category of this class.
Specified by:
? extends Attribute> getCategory in interface Attribute
Returns:
The class PrintStateReasons itself.

getName

public String getName()
Returns the name of this attribute.
Specified by:
getName in interface Attribute
Returns:
The name "printer-state-reasons".

printerStateReasonSet

public Set 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.
PrinterStateReasons.java -- Copyright (C) 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About