java.lang.Object
javax.print.attribute.TextSyntax
javax.print.attribute.standard.DocumentName
- All Implemented Interfaces:
Serializable
,Cloneable
,Attribute
,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.
- See Also:
-
Constructor Summary
ConstructorDescriptionDocumentName
(String documentName, Locale locale) Constructs a new document name attribute with the given document name and locale. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns whether this document 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 String
getName()
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 Details
-
DocumentName
Constructs a new document name attribute with the given document name and locale.- Parameters:
documentName
- document namelocale
- natural language of the text string.null
is interpreted to mean the default locale as returned byLocale.getDefault()
- Throws:
NullPointerException
- ifdocumentName
isnull
-
-
Method Details
-
equals
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 notnull
.object
is 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:
equals
in classTextSyntax
- Parameters:
object
-Object
to compare to- Returns:
true
ifobject
is equivalent to this document name attribute,false
otherwise- See Also:
-
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 classDocumentName
itself.- Specified by:
getCategory
in interfaceAttribute
- Returns:
- printing attribute class (category), an instance of class
java.lang.Class
-
getName
Get the name of the category of which this attribute value is an instance.For class
DocumentName
, the category name is"document-name"
.
-