javax.print.attribute.standard: public final class: PrinterMessageFromOperator

javax.print.attribute.standard
public final class: PrinterMessageFromOperator [javadoc | source]

java.lang.Object
   javax.print.attribute.TextSyntax
      javax.print.attribute.standard.PrinterMessageFromOperator

All Implemented Interfaces:
PrintServiceAttribute, Cloneable, java$io$Serializable

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.

author: Alan - Kaminsky

Field Summary
static final long	serialVersionUID

Constructor:

Constructor:
public PrinterMessageFromOperator(String message, Locale locale) { super (message, 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. exception: `NullPointerException` - (unchecked exception) Thrown if `message` is null.

 public PrinterMessageFromOperator(String message,
    Locale locale) {
        super (message, 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.

exception: NullPointerException - (unchecked exception) Thrown if message is null.

Method from javax.print.attribute.standard.PrinterMessageFromOperator Summary:
equals, getCategory, getName

Methods from javax.print.attribute.TextSyntax:
equals, getLocale, getValue, hashCode, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.print.attribute.standard.PrinterMessageFromOperator Detail:
public boolean equals(Object object) { return (super.equals(object) && object instanceof PrinterMessageFromOperator); } 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.
public final Class<Attribute> getCategory() { return PrinterMessageFromOperator.class; } 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.
public final String getName() { return "printer-message-from-operator"; } 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"`.

Method from javax.print.attribute.standard.PrinterMessageFromOperator Detail:

 public boolean equals(Object object) {
        return (super.equals(object) &&
                object instanceof PrinterMessageFromOperator);
}

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.

 public final Class<Attribute> getCategory() {
        return PrinterMessageFromOperator.class;
}

For class PrinterMessageFromOperator, the category is class PrinterMessageFromOperator itself.

 public final String getName() {
        return "printer-message-from-operator";
}

For class PrinterMessageFromOperator, the category name is "printer-message-from-operator".