java.lang.Object
javax.print.attribute.TextSyntax
javax.print.attribute.standard.JobName
- All Implemented Interfaces:
- Serializable,- Cloneable,- Attribute,- PrintJobAttribute,- PrintRequestAttribute
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:
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionbooleanReturns 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.final StringgetName()Get the name of the category of which this attribute value is an instance.Methods declared in class javax.print.attribute.TextSyntaxgetLocale, getValue, hashCode, toString
- 
Constructor Details- 
JobNameConstructs a new job name attribute with the given job name and locale.- Parameters:
- jobName- job name
- locale- natural language of the text string.- nullis interpreted to mean the default locale as returned by- Locale.getDefault()
- Throws:
- NullPointerException- if- jobNameis- null
 
 
- 
- 
Method Details- 
equalsReturns 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.
 - Overrides:
- equalsin class- TextSyntax
- Parameters:
- object-- Objectto compare to
- Returns:
- trueif- objectis equivalent to this job name attribute,- falseotherwise
- See Also:
 
- 
getCategoryGet the printing attribute class which is to be used as the "category" for this printing attribute value.For class JobName, the category is classJobNameitself.- Specified by:
- getCategoryin interface- Attribute
- Returns:
- printing attribute class (category), an instance of class
         java.lang.Class
 
- 
getNameGet the name of the category of which this attribute value is an instance.For class JobName, the category name is"job-name".
 
-