javax.print.attribute.standard
Class JobName
- java.lang.Object
-
- javax.print.attribute.TextSyntax
-
- javax.print.attribute.standard.JobName
-
- All Implemented Interfaces:
- Serializable, Cloneable, Attribute, PrintJobAttribute, PrintRequestAttribute
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) theDocumentNameattribute 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
Constructors Constructor and Description JobName(String jobName, Locale locale)Constructs a new job name attribute with the given job name and locale.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description booleanequals(Object object)Returns whether this job name attribute is equivalent to the passed in object.Class<? extends Attribute>getCategory()Get the printing attribute class which is to be used as the "category" for this printing attribute value.StringgetName()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
-
-
-
-
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 byLocale.getDefault() - Throws:
-
NullPointerException- (unchecked exception) Thrown ifjobNameis 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: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 classTextSyntax - Parameters:
-
object- Object to compare to. - Returns:
-
True if
objectis equivalent to this job name attribute, false otherwise. - See Also:
-
Object.hashCode(),HashMap
getCategory
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.
- Specified by:
-
getCategoryin interfaceAttribute - Returns:
-
Printing attribute class (category), an instance of class
java.lang.Class.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
