1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/rt/emul/compact/src/main/java/java/text/Annotation.java Thu Oct 03 15:40:35 2013 +0200
1.3 @@ -0,0 +1,84 @@
1.4 +/*
1.5 + * Copyright (c) 1997, 2002, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package java.text;
1.30 +
1.31 +/**
1.32 +* An Annotation object is used as a wrapper for a text attribute value if
1.33 +* the attribute has annotation characteristics. These characteristics are:
1.34 +* <ul>
1.35 +* <li>The text range that the attribute is applied to is critical to the
1.36 +* semantics of the range. That means, the attribute cannot be applied to subranges
1.37 +* of the text range that it applies to, and, if two adjacent text ranges have
1.38 +* the same value for this attribute, the attribute still cannot be applied to
1.39 +* the combined range as a whole with this value.
1.40 +* <li>The attribute or its value usually do no longer apply if the underlying text is
1.41 +* changed.
1.42 +* </ul>
1.43 +*
1.44 +* An example is grammatical information attached to a sentence:
1.45 +* For the previous sentence, you can say that "an example"
1.46 +* is the subject, but you cannot say the same about "an", "example", or "exam".
1.47 +* When the text is changed, the grammatical information typically becomes invalid.
1.48 +* Another example is Japanese reading information (yomi).
1.49 +*
1.50 +* <p>
1.51 +* Wrapping the attribute value into an Annotation object guarantees that
1.52 +* adjacent text runs don't get merged even if the attribute values are equal,
1.53 +* and indicates to text containers that the attribute should be discarded if
1.54 +* the underlying text is modified.
1.55 +*
1.56 +* @see AttributedCharacterIterator
1.57 +* @since 1.2
1.58 +*/
1.59 +
1.60 +public class Annotation {
1.61 +
1.62 + /**
1.63 + * Constructs an annotation record with the given value, which
1.64 + * may be null.
1.65 + * @param value The value of the attribute
1.66 + */
1.67 + public Annotation(Object value) {
1.68 + this.value = value;
1.69 + }
1.70 +
1.71 + /**
1.72 + * Returns the value of the attribute, which may be null.
1.73 + */
1.74 + public Object getValue() {
1.75 + return value;
1.76 + }
1.77 +
1.78 + /**
1.79 + * Returns the String representation of this Annotation.
1.80 + */
1.81 + public String toString() {
1.82 + return getClass().getName() + "[value=" + value + "]";
1.83 + }
1.84 +
1.85 + private Object value;
1.86 +
1.87 +};