No cache version.
Caching disabled. Default setting for this page:enabled (code LNG204)If the display is too slow, you can disable the user mode to view the cached version.
- 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
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. SeeJobName
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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description DocumentName(String documentName, Locale locale)
Constructs a new document name attribute with the given document name and locale.
-
Method Summary
Methods Modifier and Type Method and Description boolean
equals(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.String
getName()
Get the name of the category of which this attribute value is an instance.
-
-
-
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 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 ifdocumentName
is null.
-
-
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:-
object
is not null. -
object
is an instance of class DocumentName. -
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 if
object
is equivalent to this document 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 DocumentName, the category is class DocumentName itself.
- Specified by:
getCategory
in interfaceAttribute
- Returns:
- Printing attribute class (category), an instance of class
java.lang.Class
.
-
-
Can not display this page of the Infobrol website
Type of error (18-01)
Unknown format specifier "&"Please try again in a few minutes…
Steph