AttributedCharacterIterator.Attribute

public static class AttributedCharacterIterator.Attribute
extends Object implements Serializable

java.lang.Object
   ↳ java.text.AttributedCharacterIterator.Attribute


Defines attribute keys that are used to identify text attributes. These keys are used in AttributedCharacterIterator and AttributedString.

Summary

Fields

public static final AttributedCharacterIterator.Attribute INPUT_METHOD_SEGMENT

Attribute key for input method segments.

public static final AttributedCharacterIterator.Attribute LANGUAGE

Attribute key for the language of some text.

public static final AttributedCharacterIterator.Attribute READING

Attribute key for the reading of some text.

Protected constructors

AttributedCharacterIterator.Attribute(String name)

Constructs an Attribute with the given name.

Public methods

final boolean equals(Object obj)

Compares two objects for equality.

final int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

Protected methods

String getName()

Returns the name of the attribute.

Object readResolve()

Resolves instances being deserialized to the predefined constants.

Inherited methods

Fields

INPUT_METHOD_SEGMENT

added in API level 1
public static final AttributedCharacterIterator.Attribute INPUT_METHOD_SEGMENT

Attribute key for input method segments. Input methods often break up text into segments, which usually correspond to words.

Values are instances of Annotation holding a null reference.

See also:

LANGUAGE

added in API level 1
public static final AttributedCharacterIterator.Attribute LANGUAGE

Attribute key for the language of some text.

Values are instances of Locale.

See also:

READING

added in API level 1
public static final AttributedCharacterIterator.Attribute READING

Attribute key for the reading of some text. In languages where the written form and the pronunciation of a word are only loosely related (such as Japanese), it is often necessary to store the reading (pronunciation) along with the written form.

Values are instances of Annotation holding instances of String.

See also:

Protected constructors

AttributedCharacterIterator.Attribute

added in API level 1
protected AttributedCharacterIterator.Attribute (String name)

Constructs an Attribute with the given name.

Parameters
name String: the name of Attribute

Public methods

equals

added in API level 1
public final boolean equals (Object obj)

Compares two objects for equality. This version only returns true for x.equals(y) if x and y refer to the same object, and guarantees this for all subclasses.

Parameters
obj Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

hashCode

added in API level 1
public final int hashCode ()

Returns a hash code value for the object. This version is identical to the one in Object, but is also final.

Returns
int a hash code value for this object.

toString

added in API level 1
public String toString ()

Returns a string representation of the object. This version returns the concatenation of class name, "(", a name identifying the attribute and ")".

Returns
String a string representation of the object.

Protected methods

getName

added in API level 1
protected String getName ()

Returns the name of the attribute.

Returns
String the name of Attribute

readResolve

added in API level 1
protected Object readResolve ()

Resolves instances being deserialized to the predefined constants.

Returns
Object the resolved Attribute object

Throws
InvalidObjectException if the object to resolve is not an instance of Attribute