File Doc Category Size Date Package
JobMessageFromOperator.java API Doc Java SE 5 API 3995 Fri Aug 26 14:57:44 BST 2005 javax.print.attribute.standard

JobMessageFromOperator

java.lang.Object
- javax.print.attribute.TextSyntax

public final class JobMessageFromOperator extends TextSyntax implements PrintJobAttribute

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

Fields Summary
private static final long
serialVersionUID
Constructors Summary
public JobMessageFromOperator(String message, Locale locale)
Constructs a new job message from operator attribute with the given message and locale.
param
message Message.
param
locale Natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()
exception
NullPointerException (unchecked exception) Thrown if message is null.
super (message, locale);
Methods Summary
public boolean equals(java.lang.Object object)
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.
param
object Object to compare to.
return
True if object is equivalent to this job message from operator attribute, false otherwise.
return (super.equals (object) && object instanceof JobMessageFromOperator);
public final java.lang.Class getCategory()
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.
return
Printing attribute class (category), an instance of class {@link java.lang.Class java.lang.Class}.
return JobMessageFromOperator.class;
public final java.lang.String getName()
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".
return
Attribute category name.
return "job-message-from-operator";