TextSyntax (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.print.attribute
class TextSyntax

java.lang.Object
  javax.print.attribute.TextSyntax

All Implemented Interfaces:: Serializable, Cloneable

Direct Known Subclasses:: DocumentName, JobMessageFromOperator, JobName, JobOriginatingUserName, OutputDeviceAssigned, PrinterInfo, PrinterLocation, PrinterMakeAndModel, PrinterMessageFromOperator, PrinterName, RequestingUserName

public abstract class TextSyntax
extends Object
implements Serializable, Cloneable

Class TextSyntax is an abstract base class providing the common implementation of all attributes whose value is a string. The text attribute includes a locale to indicate the natural language. Thus, a text attribute always represents a localized string. Once constructed, a text attribute's value is immutable.

See Also (auto-generated):: Locale

Constructor Summary
`protected`	`TextSyntax(String value, Locale locale)` Constructs a TextAttribute with the specified string and locale.

Method Summary
`boolean`	`equals(Object object)` Returns whether this text attribute is equivalent to the passed in object.
`Locale`	`getLocale()` Returns this text attribute's text string's natural language (locale).
`String`	`getValue()` Returns this text attribute's text string.
`int`	`hashCode()` Returns a hashcode for this text attribute.
`String`	`toString()` Returns a String identifying this text attribute.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

TextSyntax

protected TextSyntax(String value,
                     Locale locale)

Constructs a TextAttribute with the specified string and locale.

Parameters:: value - Text string.; locale - Natural language of the text string. null is interpreted to mean the default locale for as returned by Locale.getDefault()

Method Detail

equals

public boolean equals(Object object)

Returns whether this text 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 TextSyntax.
This text attribute's underlying string and object's underlying string are equal.
This text attribute's locale and object's locale are equal.

Overrides:: equals in class Object
Parameters:: object - Object to compare to.
Returns:: True if object is equivalent to this text attribute, false otherwise.

getLocale

public Locale getLocale()

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

Returns:: the locale

getValue

public String getValue()

Returns this text attribute's text string.

Returns:: the text string.

hashCode

public int hashCode()

Returns a hashcode for this text attribute.

Overrides:: hashCode in class Object
Returns:: A hashcode value for this object.

toString

public String toString()

Returns a String identifying this text attribute. The String is the attribute's underlying text string.

Overrides:: toString in class Object
Returns:: A String identifying this object.