APIdia Launch Partner
Top Description Fields Constructors Methods
javax.print.attribute.standard

public final Class DocumentName

extends TextSyntax
implements DocAttribute
Class Inheritance
All Implemented Interfaces
javax.print.attribute.DocAttribute, javax.print.attribute.Attribute, java.io.Serializable
Imports
java.io.Serial, java.util.Locale, javax.print.attribute.Attribute, .DocAttribute, .TextSyntax
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.

Author
Alan Kaminsky

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides javax.print.attribute.TextSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

AccessConstructor and Description
public
DocumentName(String
document name
documentName, Locale
natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()
locale)

Constructs a new document name attribute with the given document name and locale.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if object is equivalent to this document name attribute, false otherwise
equals(Object
Object to compare to
object)

Overrides javax.print.attribute.TextSyntax.equals.

Returns whether this document name attribute is equivalent to the passed in object.

public final Class<? extends Attribute>

Returns:

printing attribute class (category), an instance of class java.lang.Class
getCategory()

Implements javax.print.attribute.Attribute.getCategory.

Get the printing attribute class which is to be used as the "category" for this printing attribute value.

public final String

Returns:

attribute category name
getName()

Implements javax.print.attribute.Attribute.getName.

Get the name of the category of which this attribute value is an instance.

Inherited from javax.print.attribute.TextSyntax:
getLocalegetValuehashCodetoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.print.attribute.TextSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations
@Serial

Constructor Detail

DocumentNameback to summary
public DocumentName(String documentName, Locale locale)

Constructs a new document name attribute with the given document name and locale.

Parameters
documentName:String

document name

locale:Locale

natural language of the text string. null is interpreted to mean the default locale as returned by Locale.getDefault()

Exceptions
NullPointerException:
if documentName is null

Method Detail

equalsback to summary
public boolean equals(Object object)

Overrides javax.print.attribute.TextSyntax.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:

  1. object is not null.
  2. object is an instance of class DocumentName.
  3. This document name attribute's underlying string and object's underlying string are equal.
  4. This document name attribute's locale and object's locale are equal.
Parameters
object:Object

Object to compare to

Returns:boolean

true if object is equivalent to this document name attribute, false otherwise

Annotations
@Override
getCategoryback to summary
public final Class<? extends Attribute> getCategory()

Implements javax.print.attribute.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:Class<? extends Attribute>

printing attribute class (category), an instance of class java.lang.Class

Annotations
@Override
getNameback to summary
public final String getName()

Implements javax.print.attribute.Attribute.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:String

attribute category name

Annotations
@Override