| java.lang.Object | ||
| ↳ | javax.print.attribute.TextSyntax | |
| ↳ | javax.print.attribute.standard.DocumentName | |
Class Overview
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.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a new document name attribute with the given document name
and locale.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
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.
| |||||||||||
Get the name of the category of which this attribute value is an
instance.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
javax.print.attribute.TextSyntax
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
javax.print.attribute.Attribute
| |||||||||||
Public Constructors
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
by Locale.getDefault() |
Throws
| NullPointerException | (unchecked exception) Thrown if documentName is null.
|
|---|
Public Methods
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 not null. -
objectis 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. |
|---|
Returns
- True if
objectis equivalent to this document name attribute, false otherwise.
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.
Returns
- Printing attribute class (category), an instance of class
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".
Returns
- Attribute category name.