javax.print.attribute.standard
Class JobName

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

All Implemented Interfaces:

Attribute, Cloneable, PrintJobAttribute, PrintRequestAttribute, Serializable

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 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.

See Also:

Serialized Form

Constructor Summary

JobName(String jobName, Locale locale)
Constructs a new job name attribute with the given job name and locale.

Method Summary

boolean	equals(Object object) Returns whether this job name attribute is equivalent to the passed in object.
Class	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

JobName

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.

Method Detail

equals

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:

1. object is not null.
2. object is an instance of class JobName.
3. This job name attribute's underlying string and object's underlying string are equal.
4. This job name attribute's locale and object's locale are equal.

Overrides:

equals in class TextSyntax

Parameters:

object - Object to compare to.

Returns:

True if object is equivalent to this job name attribute, false otherwise.

getCategory

public final Class 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.

Specified by:

getCategory in interface Attribute

Returns:

Printing attribute class (category), an instance of class java.lang.Class.

getName

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".

Specified by:

getName in interface Attribute

Returns:

Attribute category name.