- java.lang.Object
-
- javax.print.attribute.TextSyntax
-
- javax.print.attribute.standard.DocumentName
-
- All Implemented Interfaces:
Serializable,Cloneable,Attribute,DocAttribute
public final class DocumentName extends TextSyntax implements DocAttribute
ClassDocumentNameis a printing attribute class, a text attribute, that specifies the name of a document.DocumentNameis 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, theDocumentNameshould be used instead, which implies that supporting specification ofDocumentNamerequires reporting of JobName and vice versa. SeeJobNamefor 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.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DocumentName(String documentName, Locale locale)Constructs a new document name attribute with the given document name and locale.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object object)Returns whether this document 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 declared in class javax.print.attribute.TextSyntax
getLocale, getValue, hashCode, toString
-
-
-
-
Constructor Detail
-
DocumentName
public DocumentName(String documentName, Locale locale)
Constructs a new document name attribute with the given document name and locale.- Parameters:
documentName- document namelocale- natural language of the text string.nullis interpreted to mean the default locale as returned byLocale.getDefault()- Throws:
NullPointerException- ifdocumentNameisnull
-
-
Method Detail
-
equals
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:objectis notnull.objectis an instance of classDocumentName.- This document name attribute's underlying string and
object's underlying string are equal. - This document name attribute's locale and
object's locale are equal.
- Overrides:
equalsin classTextSyntax- Parameters:
object-Objectto compare to- Returns:
trueifobjectis equivalent to this document name attribute,falseotherwise- See Also:
Object.hashCode()
-
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
DocumentName, the category is classDocumentNameitself.- Specified by:
getCategoryin interfaceAttribute- Returns:
- printing attribute class (category), an instance of class
java.lang.Class
-
-