- java.lang.Object
-
- javax.print.attribute.TextSyntax
-
- javax.print.attribute.standard.PrinterMessageFromOperator
-
- All Implemented Interfaces:
Serializable,Cloneable,Attribute,PrintServiceAttribute
public final class PrinterMessageFromOperator extends TextSyntax implements PrintServiceAttribute
ClassPrinterMessageFromOperatoris a printing attribute class, a text attribute, that provides a message from an operator, system administrator, or "intelligent" process to indicate to the end user information about or status of the printer, such as why it is unavailable or when it is expected to be available.A Print Service's attribute set includes zero instances or one instance of a
PrinterMessageFromOperatorattribute, not more than one instance. A newPrinterMessageFromOperatorattribute replaces an existingPrinterMessageFromOperatorattribute, if any. In other words,PrinterMessageFromOperatoris not intended to be a history log. If it wishes, the client can detect changes to a Print Service'sPrinterMessageFromOperatorattribute and maintain the client's own history log of thePrinterMessageFromOperatorattribute values.IPP Compatibility: The string value gives the IPP name value. The locale gives the IPP natural language. The category name returned by
getName()gives the IPP attribute name.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description PrinterMessageFromOperator(String message, Locale locale)Constructs a new printer message from operator attribute with the given message and locale.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object object)Returns whether this printer message from operator attribute is equivalent to the passed in object.Class<? extends Attribute>getCategory()Get the printing attribute class which is to be used as the "category" for this printing attribute value.StringgetName()Get the name of the category of which this attribute value is an instance.-
Methods declared in class javax.print.attribute.TextSyntax
getLocale, getValue, hashCode, toString
-
-
-
-
Constructor Detail
-
PrinterMessageFromOperator
public PrinterMessageFromOperator(String message, Locale locale)
Constructs a new printer message from operator attribute with the given message and locale.- Parameters:
message- the messagelocale- natural language of the text string.nullis interpreted to mean the default locale as returned byLocale.getDefault()- Throws:
NullPointerException- ifmessageisnull
-
-
Method Detail
-
equals
public boolean equals(Object object)
Returns whether this printer message from operator attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:objectis notnull.objectis an instance of classPrinterMessageFromOperator.- This printer message from operator attribute's underlying string
and
object's underlying string are equal. - This printer message from operator attribute's locale and
object's locale are equal.
- Overrides:
equalsin classTextSyntax- Parameters:
object-Objectto compare to- Returns:
trueifobjectis equivalent to this printer message from operator attribute,falseotherwise- See Also:
Object.hashCode(),HashMap
-
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
PrinterMessageFromOperator, the category is classPrinterMessageFromOperatoritself.- Specified by:
getCategoryin interfaceAttribute- Returns:
- printing attribute class (category), an instance of class
java.lang.Class
-
-