| java.lang.Object | ||
| ↳ | javax.print.attribute.TextSyntax | |
| ↳ | javax.print.attribute.standard.JobName | |
Class Overview
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 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.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a new job name attribute with the given job name and locale.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Returns whether this job name attribute is equivalent to the passed in
object.
| |||||||||||
Get the printing attribute class which is to be used as the "category"
for this printing attribute value.
| |||||||||||
Get the name of the category of which this attribute value is an
instance.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
javax.print.attribute.TextSyntax
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
javax.print.attribute.Attribute
| |||||||||||
Public Constructors
public JobName (String jobName, Locale locale)
Constructs a new job name attribute with the given job name and locale.
Parameters
| jobName | Job name. |
|---|---|
| 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 jobName is null.
|
|---|
Public Methods
public boolean equals (Object object)
Returns whether this job name attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:
-
objectis not null. -
objectis an instance of class JobName. -
This job name attribute's underlying string and
object's underlying string are equal. -
This job name attribute's locale and
object's locale are equal.
Parameters
| object | Object to compare to. |
|---|
Returns
- True if
objectis equivalent to this job name attribute, false otherwise.
public final Class<? extends Attribute> getCategory ()
Get the printing attribute class which is to be used as the "category" for this printing attribute value.
For class JobName, the category is class JobName itself.
Returns
- Printing attribute class (category), an instance of class
java.lang.Class.
public final String getName ()
Get the name of the category of which this attribute value is an instance.
For class JobName, the category name is "job-name".
Returns
- Attribute category name.