|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.print.attribute.TextSyntax
javax.print.attribute.standard.JobMessageFromOperator
public final class JobMessageFromOperator
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.
| Constructor Summary | |
|---|---|
JobMessageFromOperator(String message,
Locale locale)
Constructs a new job message from operator attribute with the given message and locale. |
|
| Method Summary | |
|---|---|
boolean |
equals(Object object)
Returns whether this job 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. |
| Methods inherited from class javax.print.attribute.TextSyntax |
|---|
getLocale, getValue, hashCode, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public JobMessageFromOperator(String message,
Locale locale)
message - Message.locale - Natural language of the text string. null
is interpreted to mean the default locale as returned
by Locale.getDefault()
NullPointerException - (unchecked exception) Thrown if message is null.| Method Detail |
|---|
public boolean equals(Object object)
object is not null.
object is an instance of class JobMessageFromOperator.
object's underlying string are equal.
object's locale are equal.
equals in class TextSyntaxobject - Object to compare to.
object is equivalent to this job
message from operator attribute, false otherwise.Object.hashCode(),
Hashtablepublic final Class<? extends Attribute> getCategory()
For class JobMessageFromOperator, the category is class JobMessageFromOperator itself.
getCategory in interface Attributejava.lang.Class.public final String getName()
For class JobMessageFromOperator, the
category name is "job-message-from-operator".
getName in interface Attribute
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.