- java.lang.Object
-
- java.util.AbstractMap<K,V>
-
- java.util.HashMap<PrinterStateReason,Severity>
-
- javax.print.attribute.standard.PrinterStateReasons
-
- All Implemented Interfaces:
- Serializable, Cloneable, Map<PrinterStateReason,Severity>, Attribute, PrintServiceAttribute
public final class PrinterStateReasons extends HashMap<PrinterStateReason,Severity> implements PrintServiceAttribute
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'sPrinterState
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 onePrinterStateReason
objects which pertain to the Print Service's status, and eachPrinterStateReason
object is associated with aSeverity
level of REPORT (least severe), WARNING, or ERROR (most severe). The printer adds aPrinterStateReason
object to the Print Service's PrinterStateReasons attribute when the corresponding condition becomes true of the printer, and the printer removes thePrinterStateReason
object again when the corresponding condition becomes false, regardless of whether the Print Service's overallPrinterState
also changed.Class PrinterStateReasons inherits its implementation from class
java.util.HashMap
. Each entry in the map consists of aPrinterStateReason
object (key) mapping to aSeverity
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 classjava.util.HashMap
, class PrinterStateReasons is not 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 classjava.util.Collections
).IPP Compatibility: The string values returned by each individual
PrinterStateReason
object's and the associatedSeverity
object'stoString()
methods, concatenated together with a hyphen ("-"
) in between, gives the IPP keyword value. The category name returned bygetName()
gives the IPP attribute name.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
-
Constructor Summary
Constructors Constructor and Description 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 samePrinterStateReason
-to-Severity
mappings as the given map.
-
Method Summary
Methods Modifier and Type Method and Description Class<? extends Attribute>
getCategory()
Get the printing attribute class which is to be used as the "category" for this printing attribute value.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.-
Methods inherited from class java.util.HashMap
clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, putAll, remove, size, values
-
-
-
-
Constructor Detail
-
PrinterStateReasons
public PrinterStateReasons()
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)
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)
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.
-
PrinterStateReasons
public PrinterStateReasons(Map<PrinterStateReason,Severity> map)
Construct a new printer state reasons attribute that contains the samePrinterStateReason
-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 ifmap
is null or if any key or value inmap
is null.ClassCastException
- (unchecked exception) Thrown if any key inmap
is not an instance of classPrinterStateReason
or if any value inmap
is not an instance of classSeverity
.
-
-
Method Detail
-
put
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.- Specified by:
put
in interfaceMap<PrinterStateReason,Severity>
- Overrides:
put
in classHashMap<PrinterStateReason,Severity>
- Parameters:
reason
- Printer state reason. This must be an instance of classPrinterStateReason
.severity
- Severity of the printer state reason. This must be an instance of classSeverity
.- 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 ifreason
is null orseverity
is null.ClassCastException
- (unchecked exception) Thrown ifreason
is not an instance of classPrinterStateReason
or ifseverity
is not an instance of classSeverity
.- Since:
- 1.5
-
getCategory
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.
- Specified by:
getCategory
in interfaceAttribute
- Returns:
- Printing attribute class (category), an instance of class
java.lang.Class
.
-
getName
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"
.
-
printerStateReasonSet
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 aPrinterStateReason
object. The only elements in the set view are thePrinterStateReason
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 givenSeverity
level. - Throws:
NullPointerException
- (unchecked exception) Thrown ifseverity
is null.
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/print/attribute/standard/printerstatereasons.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.