DocumentName JDK 1.6)

Description

publicfinal class DocumentName

Class DocumentName is a printing attribute class, a text attribute, that specifies the name of a document.

See also:

Constructors

public DocumentName (String documentName, Locale locale)

Constructs a new document name attribute with the given document name and 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.

Methods

Hide/Show inherited methods

public boolean equals (Object object) [Overrides TextSyntax]

Returns whether this document name attribute is equivalent to the passed in 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.

Returns: True if object is equivalent to this document name attribute, false otherwise.
Parameters:
- object - Object to compare to.

publicfinal Class<Attribute> getCategory ()

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

public Locale getLocale () [Inherited From TextSyntax]

Returns this text attribute's text string's natural language (locale).

publicfinal String getName ()

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

public String getValue () [Inherited From TextSyntax]

Returns this text attribute's text string.

public int hashCode () [Inherited From TextSyntax]

Returns a hashcode for this text attribute.

public String toString () [Inherited From TextSyntax]

Returns a String identifying this text attribute.