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

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

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

All Implemented Interfaces:
PrintJobAttribute, Cloneable, Serializable

Class JobMessageFromOperator 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 the reasons for modification or other management action taken on a job.

A Print Job's attribute set includes zero instances or one instance of a JobMessageFromOperator attribute, not more than one instance. A new JobMessageFromOperator attribute replaces an existing JobMessageFromOperator attribute, if any. In other words, JobMessageFromOperator is not intended to be a history log. If it wishes, the client can detect changes to a Print Job's JobMessageFromOperator attribute and maintain the client's own history log of the JobMessageFromOperator 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

Constructor:

Constructor:
public JobMessageFromOperator(String message, Locale locale) { super (message, locale); } Constructs a new job 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 JobMessageFromOperator(String message,
    Locale locale) {
                                                                 
        super (message, locale);
}

Constructs a new job 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.JobMessageFromOperator 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.JobMessageFromOperator Detail:
public boolean equals(Object object) { return (super.equals (object) && object instanceof JobMessageFromOperator); } Returns whether this job 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 JobMessageFromOperator. This job message from operator attribute's underlying string and `object`'s underlying string are equal. This job message from operator attribute's locale and `object`'s locale are equal.
public final Class getCategory() { return JobMessageFromOperator.class; } Get the printing attribute class which is to be used as the "category" for this printing attribute value. For class JobMessageFromOperator, the category is class JobMessageFromOperator itself.
public final String getName() { return "job-message-from-operator"; } Get the name of the category of which this attribute value is an instance. For class JobMessageFromOperator, the category name is `"job-message-from-operator"`.

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

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

object is not null.
object is an instance of class JobMessageFromOperator.
This job message from operator attribute's underlying string and object's underlying string are equal.
This job message from operator attribute's locale and object's locale are equal.

 public final Class getCategory() {
        return JobMessageFromOperator.class;
}

For class JobMessageFromOperator, the category is class JobMessageFromOperator itself.

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

For class JobMessageFromOperator, the category name is "job-message-from-operator".