Added in API level 1

Summary: Fields | Protected Ctors | Methods | Protected Methods | Inherited Methods

AttributedCharacterIterator.Attribute

public static class AttributedCharacterIterator.Attribute
extends Object implements Serializable

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

Known direct subclasses

Format.Field, TextAttribute

Format.Field	Defines constants that are used as attribute keys in the `AttributedCharacterIterator` returned from `Format.formatToCharacterIterator` and as field identifiers in `FieldPosition`.
TextAttribute	The `TextAttribute` class defines attribute keys and attribute values used for text rendering.

Known indirect subclasses

DateFormat.Field, MessageFormat.Field, NumberFormat.Field

DateFormat.Field	The instances of this inner class are used as attribute keys and values in AttributedCharacterIterator that DateFormat.formatToCharacterIterator() method returns.
MessageFormat.Field	Defines constants that are used as attribute keys in the `AttributedCharacterIterator` returned from `MessageFormat.formatToCharacterIterator`.
NumberFormat.Field	Defines constants that are used as attribute keys in the `AttributedCharacterIterator` returned from `NumberFormat.formatToCharacterIterator` and as field identifiers in `FieldPosition`.

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

See also:

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
`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

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

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:

Annotation

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:

Locale

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:

Annotation
String

Protected constructors

Attribute

Added in API level 1

protected 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`