| java.lang.Object | ||
| ↳ | javax.print.attribute.TextSyntax | |
| ↳ | javax.print.attribute.standard.PrinterMessageFromOperator | |
Class Overview
Class 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.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a new printer message from operator attribute with the
given message and locale.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Returns 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.
| |||||||||||
Get the name of the category of which this attribute value is an
instance.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
javax.print.attribute.TextSyntax
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
javax.print.attribute.Attribute
| |||||||||||
Public Constructors
public PrinterMessageFromOperator (String message, Locale locale)
Constructs a new printer message from operator attribute with the given message and locale.
Parameters
| message | Message. |
|---|---|
| locale | Natural language of the text string. null
is interpreted to mean the default locale as returned
by Locale.getDefault() |
Throws
| NullPointerException | (unchecked exception) Thrown if message is null.
|
|---|
Public Methods
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 not null. -
objectis an instance of class PrinterMessageFromOperator. -
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.
Parameters
| object | Object to compare to. |
|---|
Returns
- True if
objectis equivalent to this printer message from operator attribute, false otherwise.
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 class PrinterMessageFromOperator itself.
Returns
- Printing attribute class (category), an instance of class
java.lang.Class.
public final String 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".
Returns
- Attribute category name.