| |
|
| java.lang.Object
 javax.print.attribute.TextSyntax
javax.print.attribute.standard.DocumentName
| DocumentName | | final public class DocumentName extends TextSyntax implements DocAttribute(Code) | | 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 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.
author:
Alan Kaminsky |
| Constructor Summary | |
| public | DocumentName(String documentName, Locale locale)
Constructs a new document name attribute with the given document name
and locale. |
| Method Summary | |
| 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. | | final public 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. | | final public String | getName()
Get the name of the category of which this attribute value is an
instance. |
| DocumentName | | public DocumentName(String documentName, Locale locale)(Code) | | Constructs a new document name attribute with the given document name
and locale.
Parameters:
documentName - Document name.
Parameters:
locale - Natural language of the text string. nullis interpreted to mean the default locale as returnedby Locale.getDefault()
exception:
NullPointerException - (unchecked exception) Thrown if documentName is null. |
| equals | | public boolean equals(Object object)(Code) | | 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.
Parameters:
object - Object to compare to. True if object is equivalent to this documentname attribute, false otherwise. |
| getCategory | | final public Class<? extends Attribute> getCategory()(Code) | | 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.
Printing attribute class (category), an instance of classjava.lang.Class java.lang.Class. |
| getName | | final public String getName()(Code) | | Get the name of the category of which this attribute value is an
instance.
For class DocumentName, the category name is "document-name".
Attribute category name. |
|
|
|