Java™ Platform
Standard Ed. 6

Class Annotation

  extended by java.text.Annotation

public class Annotation
extends Object

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

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:

Constructor Summary
Annotation(Object value)
          Constructs an annotation record with the given value, which may be null.
Method Summary
 Object getValue()
          Returns the value of the attribute, which may be null.
 String toString()
          Returns the String representation of this Annotation.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail


public Annotation(Object value)
Constructs an annotation record with the given value, which may be null.

value - The value of the attribute
Method Detail


public Object getValue()
Returns the value of the attribute, which may be null.


public String toString()
Returns the String representation of this Annotation.

toString in class Object
a string representation of the object.

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.