Skip to content

Most visited

Recently visited

navigation

Annotation

public class Annotation
extends Object

java.lang.Object
   ↳ java.text.Annotation


An Annotation object is used as a wrapper for a text attribute value if the attribute has annotation characteristics. These characteristics are:

  • The text range that the attribute is applied to is critical to the semantics of the range. That means, the attribute cannot be applied to subranges of the text range that it applies to, and, if two adjacent text ranges have the same value for this attribute, the attribute still cannot be applied to the combined range as a whole with this value.
  • The attribute or its value usually do no longer apply if the underlying text is changed.
An example is grammatical information attached to a sentence: For the previous sentence, you can say that "an example" is the subject, but you cannot say the same about "an", "example", or "exam". When the text is changed, the grammatical information typically becomes invalid. Another example is Japanese reading information (yomi).

Wrapping the attribute value into an Annotation object guarantees that adjacent text runs don't get merged even if the attribute values are equal, and indicates to text containers that the attribute should be discarded if the underlying text is modified.

See also:

Summary

Public constructors

Annotation(Object value)

Constructs an annotation record with the given value, which may be null.

Public methods

Object getValue()

Returns the value of the attribute, which may be null.

String toString()

Returns the String representation of this Annotation.

Inherited methods

From class java.lang.Object

Public constructors

Annotation

Added in API level 1
Annotation (Object value)

Constructs an annotation record with the given value, which may be null.

Parameters
value Object: The value of the attribute

Public methods

getValue

Added in API level 1
Object getValue ()

Returns the value of the attribute, which may be null.

Returns
Object

toString

Added in API level 1
String toString ()

Returns the String representation of this Annotation.

Returns
String a string representation of the object.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.