- All Implemented Interfaces:
Serializable,Cloneable,Attribute,PrintServiceAttribute
PrinterMessageFromOperator is 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
PrinterMessageFromOperator attribute, not more than one instance. A
new PrinterMessageFromOperator attribute replaces an existing
PrinterMessageFromOperator attribute, if any. In other words,
PrinterMessageFromOperator is not intended to be a history log. If it
wishes, the client can detect changes to a Print Service's
PrinterMessageFromOperator attribute and maintain the client's own
history log of the PrinterMessageFromOperator attribute 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:
-
Constructor Summary
ConstructorsConstructorDescriptionPrinterMessageFromOperator(String message, Locale locale) Constructs a new printer message from operator attribute with the given message and locale. -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns whether this printer message from operator attribute is equivalent to the passed in object.Get the printing attribute class which is to be used as the "category" for this printing attribute value.final 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 Details
-
PrinterMessageFromOperator
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 Details
-
equals
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:
-
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
-
getName
Get the name of the category of which this attribute value is an instance.For class
PrinterMessageFromOperator, the category name is"printer-message-from-operator".
-