| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public final class JobName extends TextSyntax implements PrintRequestAttribute, PrintJobAttribute
Class JobName is a printing attribute class, a text attribute, that specifies the name of a print job. A job's name is an arbitrary string defined by the client. It does not need to be unique between different jobs. A Print Job's JobName attribute is set to the value supplied by the client in the Print Request's attribute set. If, however, the client does not supply a JobName attribute in the Print Request, the printer, when it creates the Print Job, must generate a JobName. The printer should generate the value of the Print Job's JobName attribute from the first of the following sources that produces a value: (1) the {@link DocumentName DocumentName} attribute of the first (or only) doc in the job, (2) the URL of the first (or only) doc in the job, if the doc's print data representation object is a URL, or (3) any other piece of Print Job specific and/or document content information.
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 | |
---|---|
Constructs a new job name attribute with the given job name and locale. |
Method Summary | |
---|---|
boolean |
Returns whether this job name attribute is equivalent to the passed in object. |
Class |
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 |
---|
equals, getLocale, getValue, hashCode, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JobName(String jobName, Locale locale)
jobName
- Job name.locale
- Natural language of the text string. null
is interpreted to mean the default locale as returned
by Locale.getDefault()
Method Detail |
---|
public boolean equals(Object object)
object
is not null.
object
is an instance of class JobName.
object
's
underlying string are equal.
object
's locale are
equal.
equals
in class TextSyntax
object
- Object to compare to.object
is equivalent to this job name
attribute, false otherwise.public final Class getCategory()
For class JobName, the category is class JobName itself.
public final String getName()
For class JobName, the category name is "job-name"
.
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |