1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
/* * @(#)AttributedCharacterIterator.java 1.33 05/11/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.text; import java.io.InvalidObjectException; import java.io.Serializable; import java.util.HashMap; import java.util.Map; import java.util.Set; /** * An AttributedCharacterIterator allows iteration through both text and * related attribute information. * * <p> * An attribute is a key/value pair, identified by the key. No two * attributes on a given character can have the same key. * * <p>The values for an attribute are immutable, or must not be mutated * by clients or storage. They are always passed by reference, and not * cloned. * * <p>A <em>run with respect to an attribute</em> is a maximum text range for * which: * <ul> * <li>the attribute is undefined or null for the entire range, or * <li>the attribute value is defined and has the same non-null value for the * entire range. * </ul> * * <p>A <em>run with respect to a set of attributes</em> is a maximum text range for * which this condition is met for each member attribute. * * <p>The returned indexes are limited to the range of the iterator. * * <p>The returned attribute information is limited to runs that contain * the current character. * * <p> * Attribute keys are instances of AttributedCharacterIterator.Attribute and its * subclasses, such as java.awt.font.TextAttribute. * * @see AttributedCharacterIterator.Attribute * @see java.awt.font.TextAttribute * @see AttributedString * @see Annotation * @since 1.2 */ public interface AttributedCharacterIterator extends CharacterIterator { /** * Defines attribute keys that are used to identify text attributes. These * keys are used in AttributedCharacterIterator and AttributedString. * @see AttributedCharacterIterator * @see AttributedString * @since 1.2 */ public static class Attribute implements Serializable { /** * The name of this Attribute. The name is used primarily by readResolve * to look up the corresponding predefined instance when deserializing * an instance. * @serial */ private String name; // table of all instances in this class, used by readResolve private static final Map instanceMap = new HashMap(7); /** * Constructs an Attribute with the given name. */ protected Attribute(String name) { this.name = name; if (this.getClass() == Attribute.class) { instanceMap.put(name, this); } } /** * Compares two objects for equality. This version only returns true * for <code>x.equals(y)</code> if <code>x</code> and <code>y</code> refer * to the same object, and guarantees this for all subclasses. */ public final boolean equals(Object obj) { return super.equals(obj); } /** * Returns a hash code value for the object. This version is identical to * the one in Object, but is also final. */ public final int hashCode() { return super.hashCode(); } /** * Returns a string representation of the object. This version returns the * concatenation of class name, "(", a name identifying the attribute and ")". */ public String toString() { return getClass().getName() + "(" + name + ")"; } /** * Returns the name of the attribute. */ protected String getName() { return name; } /** * Resolves instances being deserialized to the predefined constants. */ protected Object readResolve() throws InvalidObjectException { if (this.getClass() != Attribute.class) { throw new InvalidObjectException("subclass didn't correctly implement readResolve"); } Attribute instance = (Attribute) instanceMap.get(getName()); if (instance != null) { return instance; } else { throw new InvalidObjectException("unknown attribute name"); } } /** * Attribute key for the language of some text. * <p> Values are instances of Locale. * @see java.util.Locale */ public static final Attribute LANGUAGE = new Attribute("language"); /** * 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. * <p>Values are instances of Annotation holding instances of String. * @see Annotation * @see java.lang.String */ public static final Attribute READING = new Attribute("reading"); /** * Attribute key for input method segments. Input methods often break * up text into segments, which usually correspond to words. * <p>Values are instances of Annotation holding a null reference. * @see Annotation */ public static final Attribute INPUT_METHOD_SEGMENT = new Attribute("input_method_segment"); // make sure the serial version doesn't change between compiler versions private static final long serialVersionUID = -9142742483513960612L; }; /** * Returns the index of the first character of the run * with respect to all attributes containing the current character. */ public int getRunStart(); /** * Returns the index of the first character of the run * with respect to the given attribute containing the current character. */ public int getRunStart(Attribute attribute); /** * Returns the index of the first character of the run * with respect to the given attributes containing the current character. */ public int getRunStart(Set<? extends Attribute> attributes); /** * Returns the index of the first character following the run * with respect to all attributes containing the current character. */ public int getRunLimit(); /** * Returns the index of the first character following the run * with respect to the given attribute containing the current character. */ public int getRunLimit(Attribute attribute); /** * Returns the index of the first character following the run * with respect to the given attributes containing the current character. */ public int getRunLimit(Set<? extends Attribute> attributes); /** * Returns a map with the attributes defined on the current * character. */ public Map<Attribute,Object> getAttributes(); /** * Returns the value of the named attribute for the current character. * Returns null if the attribute is not defined. * @param attribute the key of the attribute whose value is requested. */ public Object getAttribute(Attribute attribute); /** * Returns the keys of all attributes defined on the * iterator's text range. The set is empty if no * attributes are defined. */ public Set<Attribute> getAllAttributeKeys(); };