[ Web Proxy ]
URL:
Viewing: https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/text/Annotation.html [Back]  [Original]
Annotation (Java SE 24 & JDK 24)
  1. java.base
  2. java.text
  3. Annotation
Contents 
Hide sidebar ❮❯ Show sidebar
  1. Description
  2. Constructor Summary
  3. Method Summary
  4. Constructor Details
    1. Annotation(Object)
  5. Method Details
    1. getValue()
    2. toString()

Class Annotation

java.lang.Object
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:
  • 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.

Since:
1.2
See Also:

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2025, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.

Web Proxy Viewer  |  New URL  |  Original Page