public final class DocumentName extends TextSyntax implements DocAttribute
Class DocumentName is a printing attribute class, a text attribute, that specifies the name of a document. DocumentName is an attribute of the print data (the doc), not of the Print Job. A document's name is an arbitrary string defined by the client. However if a JobName is not specified, the DocumentName should be used instead, which implies that supporting specification of DocumentName requires reporting of JobName and vice versa. See JobName
for more 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.
public DocumentName(String documentName, Locale locale)
Constructs a new document name attribute with the given document name and locale.
documentName
- Document name.locale
- Natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()
NullPointerException
- (unchecked exception) Thrown if documentName
is null.public boolean equals(Object object)
Returns whether this document 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 DocumentName. object
's underlying string are equal. object
's locale are equal. equals
in class TextSyntax
object
- Object to compare to.object
is equivalent to this document name attribute, false otherwise.Object.hashCode()
, HashMap
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 DocumentName, the category is class DocumentName itself.
getCategory
in interface Attribute
java.lang.Class
.public final String getName()
Get the name of the category of which this attribute value is an instance.
For class DocumentName, the category name is "document-name"
.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.