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 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
/* * @(#)Segment.java 1.25 06/04/07 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.swing.text; import java.text.CharacterIterator; /** * A segment of a character array representing a fragment * of text. It should be treated as immutable even though * the array is directly accessible. This gives fast access * to fragments of text without the overhead of copying * around characters. This is effectively an unprotected * String. * <p> * The Segment implements the java.text.CharacterIterator * interface to support use with the i18n support without * copying text into a string. * * @author Timothy Prinzing * @version 1.25 04/07/06 */ public class Segment implements Cloneable, CharacterIterator, CharSequence { /** * This is the array containing the text of * interest. This array should never be modified; * it is available only for efficiency. */ public char[] array; /** * This is the offset into the array that * the desired text begins. */ public int offset; /** * This is the number of array elements that * make up the text of interest. */ public int count; private boolean partialReturn; /** * Creates a new segment. */ public Segment() { this(null, 0, 0); } /** * Creates a new segment referring to an existing array. * * @param array the array to refer to * @param offset the offset into the array * @param count the number of characters */ public Segment(char[] array, int offset, int count) { this.array = array; this.offset = offset; this.count = count; partialReturn = false; } /** * Flag to indicate that partial returns are valid. If the flag is true, * an implementation of the interface method Document.getText(position,length,Segment) * should return as much text as possible without making a copy. The default * state of the flag is false which will cause Document.getText(position,length,Segment) * to provide the same return behavior it always had, which may or may not * make a copy of the text depending upon the request. * * @param p whether or not partial returns are valid. * @since 1.4 */ public void setPartialReturn(boolean p) { partialReturn = p; } /** * Flag to indicate that partial returns are valid. * * @return whether or not partial returns are valid. * @since 1.4 */ public boolean isPartialReturn() { return partialReturn; } /** * Converts a segment into a String. * * @return the string */ public String toString() { if (array != null) { return new String(array, offset, count); } return new String(); } // --- CharacterIterator methods ------------------------------------- /** * Sets the position to getBeginIndex() and returns the character at that * position. * @return the first character in the text, or DONE if the text is empty * @see #getBeginIndex * @since 1.3 */ public char first() { pos = offset; if (count != 0) { return array[pos]; } return DONE; } /** * Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) * and returns the character at that position. * @return the last character in the text, or DONE if the text is empty * @see #getEndIndex * @since 1.3 */ public char last() { pos = offset + count; if (count != 0) { pos -= 1; return array[pos]; } return DONE; } /** * Gets the character at the current position (as returned by getIndex()). * @return the character at the current position or DONE if the current * position is off the end of the text. * @see #getIndex * @since 1.3 */ public char current() { if (count != 0 && pos < offset + count) { return array[pos]; } return DONE; } /** * Increments the iterator's index by one and returns the character * at the new index. If the resulting index is greater or equal * to getEndIndex(), the current index is reset to getEndIndex() and * a value of DONE is returned. * @return the character at the new position or DONE if the new * position is off the end of the text range. * @since 1.3 */ public char next() { pos += 1; int end = offset + count; if (pos >= end) { pos = end; return DONE; } return current(); } /** * Decrements the iterator's index by one and returns the character * at the new index. If the current index is getBeginIndex(), the index * remains at getBeginIndex() and a value of DONE is returned. * @return the character at the new position or DONE if the current * position is equal to getBeginIndex(). * @since 1.3 */ public char previous() { if (pos == offset) { return DONE; } pos -= 1; return current(); } /** * Sets the position to the specified position in the text and returns that * character. * @param position the position within the text. Valid values range from * getBeginIndex() to getEndIndex(). An IllegalArgumentException is thrown * if an invalid value is supplied. * @return the character at the specified position or DONE if the specified position is equal to getEndIndex() * @since 1.3 */ public char setIndex(int position) { int end = offset + count; if ((position < offset) || (position > end)) { throw new IllegalArgumentException("bad position: " + position); } pos = position; if ((pos != end) && (count != 0)) { return array[pos]; } return DONE; } /** * Returns the start index of the text. * @return the index at which the text begins. * @since 1.3 */ public int getBeginIndex() { return offset; } /** * Returns the end index of the text. This index is the index of the first * character following the end of the text. * @return the index after the last character in the text * @since 1.3 */ public int getEndIndex() { return offset + count; } /** * Returns the current index. * @return the current index. * @since 1.3 */ public int getIndex() { return pos; } // --- CharSequence methods ------------------------------------- /** * {@inheritDoc} * @since 1.6 */ public char charAt(int index) { if (index < 0 || index >= count) { throw new StringIndexOutOfBoundsException(index); } return array[offset + index]; } /** * {@inheritDoc} * @since 1.6 */ public int length() { return count; } /** * {@inheritDoc} * @since 1.6 */ public CharSequence subSequence(int start, int end) { if (start < 0) { throw new StringIndexOutOfBoundsException(start); } if (end > count) { throw new StringIndexOutOfBoundsException(end); } if (start > end) { throw new StringIndexOutOfBoundsException(end - start); } Segment segment = new Segment(); segment.array = this.array; segment.offset = this.offset + start; segment.count = end - start; return segment; } /** * Creates a shallow copy. * * @return the copy */ public Object clone() { Object o; try { o = super.clone(); } catch (CloneNotSupportedException cnse) { o = null; } return o; } private int pos; }