javax.print.attribute.standard: public final class: JobName

javax.print.attribute.standard
public final class: JobName [javadoc | source]

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

All Implemented Interfaces:
PrintJobAttribute, PrintRequestAttribute, Cloneable, java$io$Serializable

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

Constructor:

Constructor:
public JobName(String jobName, Locale locale) { super (jobName, 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. exception: `NullPointerException` - (unchecked exception) Thrown if `jobName` is null.

 public JobName(String jobName,
    Locale locale) {
        super (jobName, 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.

exception: NullPointerException - (unchecked exception) Thrown if jobName is null.

Method from javax.print.attribute.standard.JobName Summary:
equals, getCategory, getName

Methods from javax.print.attribute.TextSyntax:
equals, getLocale, getValue, hashCode, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.print.attribute.standard.JobName Detail:
public boolean equals(Object object) { return (super.equals(object) && object instanceof JobName); } Returns whether this job name attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true: `object` is not null. `object` is 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.
public final Class<Attribute> getCategory() { return JobName.class; } 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.
public final String getName() { return "job-name"; } Get the name of the category of which this attribute value is an instance. For class JobName, the category name is `"job-name"`.

Method from javax.print.attribute.standard.JobName Detail:

 public boolean equals(Object object) {
        return (super.equals(object) && object instanceof JobName);
}

object is not null.
object is 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.

 public final Class<Attribute> getCategory() {
        return JobName.class;
}

For class JobName, the category is class JobName itself.

 public final String getName() {
        return "job-name";
}

For class JobName, the category name is "job-name".