- 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
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.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description PrinterMessageFromOperator(String message, Locale locale)
Constructs a new printer message from operator attribute with the given message and locale.
-
Method Summary
Methods Modifier and Type Method and Description boolean
equals(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.String
getName()
Get the name of the category of which this attribute value is an instance.
-
-
-
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
- Message.locale
- Natural language of the text string. null is interpreted to mean the default locale as returned byLocale.getDefault()
- Throws:
NullPointerException
- (unchecked exception) Thrown ifmessage
is null.
-
-
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:-
object
is not null. -
object
is 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.
- Overrides:
equals
in classTextSyntax
- Parameters:
object
- Object to compare to.- Returns:
- True if
object
is equivalent to this printer message from operator attribute, false otherwise. - 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 class PrinterMessageFromOperator itself.
- Specified by:
getCategory
in interfaceAttribute
- Returns:
- Printing attribute class (category), an instance of class
java.lang.Class
.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/print/attribute/standard/printermessagefromoperator.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.