Top Description Fields Constructors Methods
javax.print.attribute.standard

public final Class JobName

extends TextSyntax
implements PrintRequestAttribute, PrintJobAttribute
Class Inheritance
All Implemented Interfaces
javax.print.attribute.PrintJobAttribute, javax.print.attribute.Attribute, java.io.Serializable, javax.print.attribute.PrintRequestAttribute
Imports
java.io.Serial, java.util.Locale, javax.print.attribute.Attribute, .PrintJobAttribute, .PrintRequestAttribute, .TextSyntax
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.

Author
Alan Kaminsky

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides javax.print.attribute.TextSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

AccessConstructor and Description
public
JobName(String
job name
jobName, Locale
natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()
locale)

Constructs a new job name attribute with the given job name and locale.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if object is equivalent to this job name attribute, false otherwise
equals(Object
Object to compare to
object)

Overrides javax.print.attribute.TextSyntax.equals.

Returns whether this job name attribute is equivalent to the passed in object.
public final Class<? extends Attribute>

Returns:

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

Implements javax.print.attribute.Attribute.getCategory.

Get the printing attribute class which is to be used as the "category" for this printing attribute value.
public final String

Returns:

attribute category name
getName()

Implements javax.print.attribute.Attribute.getName.

Get the name of the category of which this attribute value is an instance.
Inherited from javax.print.attribute.TextSyntax:
getLocalegetValuehashCodetoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.print.attribute.TextSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations
@Serial

Constructor Detail

JobNameback to summary
public JobName(String jobName, Locale locale)

Constructs a new job name attribute with the given job name and locale.

Parameters
jobName:String

job name

locale:Locale

natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()

Exceptions
NullPointerException:
if jobName is null

Method Detail

equalsback to summary
public boolean equals(Object object)

Overrides javax.print.attribute.TextSyntax.equals.

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.
Parameters
object:Object

Object to compare to

Returns:boolean

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

getCategoryback to summary
public final Class<? extends Attribute> getCategory()

Implements javax.print.attribute.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:Class<? extends Attribute>

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

getNameback to summary
public final String getName()

Implements javax.print.attribute.Attribute.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:String

attribute category name