ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/main/java/util/AbstractList.java
Revision: 1.17
Committed: Sun May 20 07:54:01 2007 UTC (17 years ago) by jsr166
Branch: MAIN
Changes since 1.16: +21 -3 lines
Log Message:
License update

File Contents

# Content
1 /*
2 * Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package java.util;
27
28 /**
29 * This class provides a skeletal implementation of the {@link List}
30 * interface to minimize the effort required to implement this interface
31 * backed by a "random access" data store (such as an array). For sequential
32 * access data (such as a linked list), {@link AbstractSequentialList} should
33 * be used in preference to this class.
34 *
35 * <p>To implement an unmodifiable list, the programmer needs only to extend
36 * this class and provide implementations for the {@link #get(int)} and
37 * {@link List#size() size()} methods.
38 *
39 * <p>To implement a modifiable list, the programmer must additionally
40 * override the {@link #set(int, Object) set(int, E)} method (which otherwise
41 * throws an {@code UnsupportedOperationException}). If the list is
42 * variable-size the programmer must additionally override the
43 * {@link #add(int, Object) add(int, E)} and {@link #remove(int)} methods.
44 *
45 * <p>The programmer should generally provide a void (no argument) and collection
46 * constructor, as per the recommendation in the {@link Collection} interface
47 * specification.
48 *
49 * <p>Unlike the other abstract collection implementations, the programmer does
50 * <i>not</i> have to provide an iterator implementation; the iterator and
51 * list iterator are implemented by this class, on top of the "random access"
52 * methods:
53 * {@link #get(int)},
54 * {@link #set(int, Object) set(int, E)},
55 * {@link #add(int, Object) add(int, E)} and
56 * {@link #remove(int)}.
57 *
58 * <p>The documentation for each non-abstract method in this class describes its
59 * implementation in detail. Each of these methods may be overridden if the
60 * collection being implemented admits a more efficient implementation.
61 *
62 * <p>This class is a member of the
63 * <a href="{@docRoot}/../technotes/guides/collections/index.html">
64 * Java Collections Framework</a>.
65 *
66 * @author Josh Bloch
67 * @author Neal Gafter
68 * @version %I%, %G%
69 * @since 1.2
70 */
71
72 public abstract class AbstractList<E> extends AbstractCollection<E> implements List<E> {
73 /**
74 * Sole constructor. (For invocation by subclass constructors, typically
75 * implicit.)
76 */
77 protected AbstractList() {
78 }
79
80 /**
81 * Appends the specified element to the end of this list (optional
82 * operation).
83 *
84 * <p>Lists that support this operation may place limitations on what
85 * elements may be added to this list. In particular, some
86 * lists will refuse to add null elements, and others will impose
87 * restrictions on the type of elements that may be added. List
88 * classes should clearly specify in their documentation any restrictions
89 * on what elements may be added.
90 *
91 * <p>This implementation calls {@code add(size(), e)}.
92 *
93 * <p>Note that this implementation throws an
94 * {@code UnsupportedOperationException} unless
95 * {@link #add(int, Object) add(int, E)} is overridden.
96 *
97 * @param e element to be appended to this list
98 * @return {@code true} (as specified by {@link Collection#add})
99 * @throws UnsupportedOperationException if the {@code add} operation
100 * is not supported by this list
101 * @throws ClassCastException if the class of the specified element
102 * prevents it from being added to this list
103 * @throws NullPointerException if the specified element is null and this
104 * list does not permit null elements
105 * @throws IllegalArgumentException if some property of this element
106 * prevents it from being added to this list
107 */
108 public boolean add(E e) {
109 add(size(), e);
110 return true;
111 }
112
113 /**
114 * {@inheritDoc}
115 *
116 * @throws IndexOutOfBoundsException {@inheritDoc}
117 */
118 abstract public E get(int index);
119
120 /**
121 * {@inheritDoc}
122 *
123 * <p>This implementation always throws an
124 * {@code UnsupportedOperationException}.
125 *
126 * @throws UnsupportedOperationException {@inheritDoc}
127 * @throws ClassCastException {@inheritDoc}
128 * @throws NullPointerException {@inheritDoc}
129 * @throws IllegalArgumentException {@inheritDoc}
130 * @throws IndexOutOfBoundsException {@inheritDoc}
131 */
132 public E set(int index, E element) {
133 throw new UnsupportedOperationException();
134 }
135
136 /**
137 * {@inheritDoc}
138 *
139 * <p>This implementation always throws an
140 * {@code UnsupportedOperationException}.
141 *
142 * @throws UnsupportedOperationException {@inheritDoc}
143 * @throws ClassCastException {@inheritDoc}
144 * @throws NullPointerException {@inheritDoc}
145 * @throws IllegalArgumentException {@inheritDoc}
146 * @throws IndexOutOfBoundsException {@inheritDoc}
147 */
148 public void add(int index, E element) {
149 throw new UnsupportedOperationException();
150 }
151
152 /**
153 * {@inheritDoc}
154 *
155 * <p>This implementation always throws an
156 * {@code UnsupportedOperationException}.
157 *
158 * @throws UnsupportedOperationException {@inheritDoc}
159 * @throws IndexOutOfBoundsException {@inheritDoc}
160 */
161 public E remove(int index) {
162 throw new UnsupportedOperationException();
163 }
164
165
166 // Search Operations
167
168 /**
169 * {@inheritDoc}
170 *
171 * <p>This implementation first gets a list iterator (with
172 * {@code listIterator()}). Then, it iterates over the list until the
173 * specified element is found or the end of the list is reached.
174 *
175 * @throws ClassCastException {@inheritDoc}
176 * @throws NullPointerException {@inheritDoc}
177 */
178 public int indexOf(Object o) {
179 ListIterator<E> e = listIterator();
180 if (o==null) {
181 while (e.hasNext())
182 if (e.next()==null)
183 return e.previousIndex();
184 } else {
185 while (e.hasNext())
186 if (o.equals(e.next()))
187 return e.previousIndex();
188 }
189 return -1;
190 }
191
192 /**
193 * {@inheritDoc}
194 *
195 * <p>This implementation first gets a list iterator that points to the end
196 * of the list (with {@code listIterator(size())}). Then, it iterates
197 * backwards over the list until the specified element is found, or the
198 * beginning of the list is reached.
199 *
200 * @throws ClassCastException {@inheritDoc}
201 * @throws NullPointerException {@inheritDoc}
202 */
203 public int lastIndexOf(Object o) {
204 ListIterator<E> e = listIterator(size());
205 if (o==null) {
206 while (e.hasPrevious())
207 if (e.previous()==null)
208 return e.nextIndex();
209 } else {
210 while (e.hasPrevious())
211 if (o.equals(e.previous()))
212 return e.nextIndex();
213 }
214 return -1;
215 }
216
217
218 // Bulk Operations
219
220 /**
221 * Removes all of the elements from this list (optional operation).
222 * The list will be empty after this call returns.
223 *
224 * <p>This implementation calls {@code removeRange(0, size())}.
225 *
226 * <p>Note that this implementation throws an
227 * {@code UnsupportedOperationException} unless {@code remove(int
228 * index)} or {@code removeRange(int fromIndex, int toIndex)} is
229 * overridden.
230 *
231 * @throws UnsupportedOperationException if the {@code clear} operation
232 * is not supported by this list
233 */
234 public void clear() {
235 removeRange(0, size());
236 }
237
238 /**
239 * {@inheritDoc}
240 *
241 * <p>This implementation gets an iterator over the specified collection
242 * and iterates over it, inserting the elements obtained from the
243 * iterator into this list at the appropriate position, one at a time,
244 * using {@code add(int, E)}.
245 * Many implementations will override this method for efficiency.
246 *
247 * <p>Note that this implementation throws an
248 * {@code UnsupportedOperationException} unless
249 * {@link #add(int, Object) add(int, E)} is overridden.
250 *
251 * @throws UnsupportedOperationException {@inheritDoc}
252 * @throws ClassCastException {@inheritDoc}
253 * @throws NullPointerException {@inheritDoc}
254 * @throws IllegalArgumentException {@inheritDoc}
255 * @throws IndexOutOfBoundsException {@inheritDoc}
256 */
257 public boolean addAll(int index, Collection<? extends E> c) {
258 boolean modified = false;
259 Iterator<? extends E> e = c.iterator();
260 while (e.hasNext()) {
261 add(index++, e.next());
262 modified = true;
263 }
264 return modified;
265 }
266
267
268 // Iterators
269
270 /**
271 * Returns an iterator over the elements in this list in proper sequence.
272 *
273 * <p>This implementation returns a straightforward implementation of the
274 * iterator interface, relying on the backing list's {@code size()},
275 * {@code get(int)}, and {@code remove(int)} methods.
276 *
277 * <p>Note that the iterator returned by this method will throw an
278 * {@code UnsupportedOperationException} in response to its
279 * {@code remove} method unless the list's {@code remove(int)} method is
280 * overridden.
281 *
282 * <p>This implementation can be made to throw runtime exceptions in the
283 * face of concurrent modification, as described in the specification
284 * for the (protected) {@code modCount} field.
285 *
286 * @return an iterator over the elements in this list in proper sequence
287 *
288 * @see #modCount
289 */
290 public Iterator<E> iterator() {
291 return new Itr();
292 }
293
294 /**
295 * {@inheritDoc}
296 *
297 * <p>This implementation returns {@code listIterator(0)}.
298 *
299 * @see #listIterator(int)
300 */
301 public ListIterator<E> listIterator() {
302 return listIterator(0);
303 }
304
305 /**
306 * {@inheritDoc}
307 *
308 * <p>This implementation returns a straightforward implementation of the
309 * {@code ListIterator} interface that extends the implementation of the
310 * {@code Iterator} interface returned by the {@code iterator()} method.
311 * The {@code ListIterator} implementation relies on the backing list's
312 * {@code get(int)}, {@code set(int, E)}, {@code add(int, E)}
313 * and {@code remove(int)} methods.
314 *
315 * <p>Note that the list iterator returned by this implementation will
316 * throw an {@code UnsupportedOperationException} in response to its
317 * {@code remove}, {@code set} and {@code add} methods unless the
318 * list's {@code remove(int)}, {@code set(int, E)}, and
319 * {@code add(int, E)} methods are overridden.
320 *
321 * <p>This implementation can be made to throw runtime exceptions in the
322 * face of concurrent modification, as described in the specification for
323 * the (protected) {@code modCount} field.
324 *
325 * @throws IndexOutOfBoundsException {@inheritDoc}
326 *
327 * @see #modCount
328 */
329 public ListIterator<E> listIterator(final int index) {
330 if (index<0 || index>size())
331 throw new IndexOutOfBoundsException("Index: "+index);
332
333 return new ListItr(index);
334 }
335
336 private class Itr implements Iterator<E> {
337 /**
338 * Index of element to be returned by subsequent call to next.
339 */
340 int cursor = 0;
341
342 /**
343 * Index of element returned by most recent call to next or
344 * previous. Reset to -1 if this element is deleted by a call
345 * to remove.
346 */
347 int lastRet = -1;
348
349 /**
350 * The modCount value that the iterator believes that the backing
351 * List should have. If this expectation is violated, the iterator
352 * has detected concurrent modification.
353 */
354 int expectedModCount = modCount;
355
356 public boolean hasNext() {
357 return cursor != size();
358 }
359
360 public E next() {
361 checkForComodification();
362 try {
363 E next = get(cursor);
364 lastRet = cursor++;
365 return next;
366 } catch (IndexOutOfBoundsException e) {
367 checkForComodification();
368 throw new NoSuchElementException();
369 }
370 }
371
372 public void remove() {
373 if (lastRet == -1)
374 throw new IllegalStateException();
375 checkForComodification();
376
377 try {
378 AbstractList.this.remove(lastRet);
379 if (lastRet < cursor)
380 cursor--;
381 lastRet = -1;
382 expectedModCount = modCount;
383 } catch (IndexOutOfBoundsException e) {
384 throw new ConcurrentModificationException();
385 }
386 }
387
388 final void checkForComodification() {
389 if (modCount != expectedModCount)
390 throw new ConcurrentModificationException();
391 }
392 }
393
394 private class ListItr extends Itr implements ListIterator<E> {
395 ListItr(int index) {
396 cursor = index;
397 }
398
399 public boolean hasPrevious() {
400 return cursor != 0;
401 }
402
403 public E previous() {
404 checkForComodification();
405 try {
406 int i = cursor - 1;
407 E previous = get(i);
408 lastRet = cursor = i;
409 return previous;
410 } catch (IndexOutOfBoundsException e) {
411 checkForComodification();
412 throw new NoSuchElementException();
413 }
414 }
415
416 public int nextIndex() {
417 return cursor;
418 }
419
420 public int previousIndex() {
421 return cursor-1;
422 }
423
424 public void set(E e) {
425 if (lastRet == -1)
426 throw new IllegalStateException();
427 checkForComodification();
428
429 try {
430 AbstractList.this.set(lastRet, e);
431 expectedModCount = modCount;
432 } catch (IndexOutOfBoundsException ex) {
433 throw new ConcurrentModificationException();
434 }
435 }
436
437 public void add(E e) {
438 checkForComodification();
439
440 try {
441 int i = cursor;
442 AbstractList.this.add(i, e);
443 cursor = i + 1;
444 lastRet = -1;
445 expectedModCount = modCount;
446 } catch (IndexOutOfBoundsException ex) {
447 throw new ConcurrentModificationException();
448 }
449 }
450 }
451
452 /**
453 * {@inheritDoc}
454 *
455 * <p>This implementation returns a list that subclasses
456 * {@code AbstractList}. The subclass stores, in private fields, the
457 * offset of the subList within the backing list, the size of the subList
458 * (which can change over its lifetime), and the expected
459 * {@code modCount} value of the backing list. There are two variants
460 * of the subclass, one of which implements {@code RandomAccess}.
461 * If this list implements {@code RandomAccess} the returned list will
462 * be an instance of the subclass that implements {@code RandomAccess}.
463 *
464 * <p>The subclass's {@code set(int, E)}, {@code get(int)},
465 * {@code add(int, E)}, {@code remove(int)}, {@code addAll(int,
466 * Collection)} and {@code removeRange(int, int)} methods all
467 * delegate to the corresponding methods on the backing abstract list,
468 * after bounds-checking the index and adjusting for the offset. The
469 * {@code addAll(Collection c)} method merely returns {@code addAll(size,
470 * c)}.
471 *
472 * <p>The {@code listIterator(int)} method returns a "wrapper object"
473 * over a list iterator on the backing list, which is created with the
474 * corresponding method on the backing list. The {@code iterator} method
475 * merely returns {@code listIterator()}, and the {@code size} method
476 * merely returns the subclass's {@code size} field.
477 *
478 * <p>All methods first check to see if the actual {@code modCount} of
479 * the backing list is equal to its expected value, and throw a
480 * {@code ConcurrentModificationException} if it is not.
481 *
482 * @throws IndexOutOfBoundsException endpoint index value out of range
483 * {@code (fromIndex < 0 || toIndex > size)}
484 * @throws IllegalArgumentException if the endpoint indices are out of order
485 * {@code (fromIndex > toIndex)}
486 */
487 public List<E> subList(int fromIndex, int toIndex) {
488 return (this instanceof RandomAccess ?
489 new RandomAccessSubList(this, this, fromIndex, fromIndex, toIndex) :
490 new SubList(this, this, fromIndex, fromIndex, toIndex));
491 }
492
493 // Comparison and hashing
494
495 /**
496 * Compares the specified object with this list for equality. Returns
497 * {@code true} if and only if the specified object is also a list, both
498 * lists have the same size, and all corresponding pairs of elements in
499 * the two lists are <i>equal</i>. (Two elements {@code e1} and
500 * {@code e2} are <i>equal</i> if {@code (e1==null ? e2==null :
501 * e1.equals(e2))}.) In other words, two lists are defined to be
502 * equal if they contain the same elements in the same order.
503 *
504 * <p>This implementation first checks if the specified object is this
505 * list. If so, it returns {@code true}; if not, it checks if the
506 * specified object is a list. If not, it returns {@code false}; if so,
507 * it iterates over both lists, comparing corresponding pairs of elements.
508 * If any comparison returns {@code false}, this method returns
509 * {@code false}. If either iterator runs out of elements before the
510 * other it returns {@code false} (as the lists are of unequal length);
511 * otherwise it returns {@code true} when the iterations complete.
512 *
513 * @param o the object to be compared for equality with this list
514 * @return {@code true} if the specified object is equal to this list
515 */
516 public boolean equals(Object o) {
517 if (o == this)
518 return true;
519 if (!(o instanceof List))
520 return false;
521
522 ListIterator<E> e1 = listIterator();
523 ListIterator e2 = ((List) o).listIterator();
524 while(e1.hasNext() && e2.hasNext()) {
525 E o1 = e1.next();
526 Object o2 = e2.next();
527 if (!(o1==null ? o2==null : o1.equals(o2)))
528 return false;
529 }
530 return !(e1.hasNext() || e2.hasNext());
531 }
532
533 /**
534 * Returns the hash code value for this list.
535 *
536 * <p>This implementation uses exactly the code that is used to define the
537 * list hash function in the documentation for the {@link List#hashCode}
538 * method.
539 *
540 * @return the hash code value for this list
541 */
542 public int hashCode() {
543 int hashCode = 1;
544 Iterator<E> i = iterator();
545 while (i.hasNext()) {
546 E obj = i.next();
547 hashCode = 31*hashCode + (obj==null ? 0 : obj.hashCode());
548 }
549 return hashCode;
550 }
551
552 /**
553 * Removes from this list all of the elements whose index is between
554 * {@code fromIndex}, inclusive, and {@code toIndex}, exclusive.
555 * Shifts any succeeding elements to the left (reduces their index).
556 * This call shortens the ArrayList by {@code (toIndex - fromIndex)}
557 * elements. (If {@code toIndex==fromIndex}, this operation has no
558 * effect.)
559 *
560 * <p>This method is called by the {@code clear} operation on this list
561 * and its subLists. Overriding this method to take advantage of
562 * the internals of the list implementation can <i>substantially</i>
563 * improve the performance of the {@code clear} operation on this list
564 * and its subLists.
565 *
566 * <p>This implementation gets a list iterator positioned before
567 * {@code fromIndex}, and repeatedly calls {@code ListIterator.next}
568 * followed by {@code ListIterator.remove} until the entire range has
569 * been removed. <b>Note: if {@code ListIterator.remove} requires linear
570 * time, this implementation requires quadratic time.</b>
571 *
572 * @param fromIndex index of first element to be removed
573 * @param toIndex index after last element to be removed
574 */
575 protected void removeRange(int fromIndex, int toIndex) {
576 ListIterator<E> it = listIterator(fromIndex);
577 for (int i=0, n=toIndex-fromIndex; i<n; i++) {
578 it.next();
579 it.remove();
580 }
581 }
582
583 /**
584 * The number of times this list has been <i>structurally modified</i>.
585 * Structural modifications are those that change the size of the
586 * list, or otherwise perturb it in such a fashion that iterations in
587 * progress may yield incorrect results.
588 *
589 * <p>This field is used by the iterator and list iterator implementation
590 * returned by the {@code iterator} and {@code listIterator} methods.
591 * If the value of this field changes unexpectedly, the iterator (or list
592 * iterator) will throw a {@code ConcurrentModificationException} in
593 * response to the {@code next}, {@code remove}, {@code previous},
594 * {@code set} or {@code add} operations. This provides
595 * <i>fail-fast</i> behavior, rather than non-deterministic behavior in
596 * the face of concurrent modification during iteration.
597 *
598 * <p><b>Use of this field by subclasses is optional.</b> If a subclass
599 * wishes to provide fail-fast iterators (and list iterators), then it
600 * merely has to increment this field in its {@code add(int, E)} and
601 * {@code remove(int)} methods (and any other methods that it overrides
602 * that result in structural modifications to the list). A single call to
603 * {@code add(int, E)} or {@code remove(int)} must add no more than
604 * one to this field, or the iterators (and list iterators) will throw
605 * bogus {@code ConcurrentModificationExceptions}. If an implementation
606 * does not wish to provide fail-fast iterators, this field may be
607 * ignored.
608 */
609 protected transient int modCount = 0;
610 }
611
612 /**
613 * Generic sublists. Non-nested to enable construction by other
614 * classes in this package.
615 */
616 class SubList<E> extends AbstractList<E> {
617 /*
618 * A SubList has both a "base", the ultimate backing list, as well
619 * as a "parent", which is the list or sublist creating this
620 * sublist. All methods that may cause structural modifications
621 * must propagate through the parent link, with O(k) performance
622 * where k is sublist depth. For example in the case of a
623 * sub-sub-list, invoking remove(x) will result in a chain of
624 * three remove calls. However, all other non-structurally
625 * modifying methods can bypass this chain, and relay directly to
626 * the base list. In particular, doing so signficantly speeds up
627 * the performance of iterators for deeply-nested sublists.
628 */
629 final AbstractList<E> base; // Backing list
630 final AbstractList<E> parent; // Parent list
631 final int baseOffset; // index wrt base
632 final int parentOffset; // index wrt parent
633 int length; // Number of elements in this sublist
634
635 SubList(AbstractList<E> base,
636 AbstractList<E> parent,
637 int baseIndex,
638 int fromIndex,
639 int toIndex) {
640 if (fromIndex < 0)
641 throw new IndexOutOfBoundsException("fromIndex = " + fromIndex);
642 if (toIndex > parent.size())
643 throw new IndexOutOfBoundsException("toIndex = " + toIndex);
644 if (fromIndex > toIndex)
645 throw new IllegalArgumentException("fromIndex(" + fromIndex +
646 ") > toIndex(" + toIndex + ")");
647 this.base = base;
648 this.parent = parent;
649 this.baseOffset = baseIndex;
650 this.parentOffset = fromIndex;
651 this.length = toIndex - fromIndex;
652 this.modCount = base.modCount;
653 }
654
655 /**
656 * Returns an IndexOutOfBoundsException with nicer message
657 */
658 private IndexOutOfBoundsException indexError(int index) {
659 return new IndexOutOfBoundsException("Index: " + index +
660 ", Size: " + length);
661 }
662
663 public E set(int index, E element) {
664 if (index < 0 || index >= length)
665 throw indexError(index);
666 if (base.modCount != modCount)
667 throw new ConcurrentModificationException();
668 return base.set(index + baseOffset, element);
669 }
670
671 public E get(int index) {
672 if (index < 0 || index >= length)
673 throw indexError(index);
674 if (base.modCount != modCount)
675 throw new ConcurrentModificationException();
676 return base.get(index + baseOffset);
677 }
678
679 public int size() {
680 if (base.modCount != modCount)
681 throw new ConcurrentModificationException();
682 return length;
683 }
684
685 public void add(int index, E element) {
686 if (index < 0 || index>length)
687 throw indexError(index);
688 if (base.modCount != modCount)
689 throw new ConcurrentModificationException();
690 parent.add(index + parentOffset, element);
691 length++;
692 modCount = base.modCount;
693 }
694
695 public E remove(int index) {
696 if (index < 0 || index >= length)
697 throw indexError(index);
698 if (base.modCount != modCount)
699 throw new ConcurrentModificationException();
700 E result = parent.remove(index + parentOffset);
701 length--;
702 modCount = base.modCount;
703 return result;
704 }
705
706 protected void removeRange(int fromIndex, int toIndex) {
707 if (base.modCount != modCount)
708 throw new ConcurrentModificationException();
709 parent.removeRange(fromIndex + parentOffset, toIndex + parentOffset);
710 length -= (toIndex-fromIndex);
711 modCount = base.modCount;
712 }
713
714 public boolean addAll(Collection<? extends E> c) {
715 return addAll(length, c);
716 }
717
718 public boolean addAll(int index, Collection<? extends E> c) {
719 if (index < 0 || index > length)
720 throw indexError(index);
721 int cSize = c.size();
722 if (cSize==0)
723 return false;
724
725 if (base.modCount != modCount)
726 throw new ConcurrentModificationException();
727 parent.addAll(parentOffset + index, c);
728 length += cSize;
729 modCount = base.modCount;
730 return true;
731 }
732
733 public List<E> subList(int fromIndex, int toIndex) {
734 return new SubList(base, this, fromIndex + baseOffset,
735 fromIndex, toIndex);
736 }
737
738 public Iterator<E> iterator() {
739 return new SubListIterator(this, 0);
740 }
741
742 public ListIterator<E> listIterator() {
743 return new SubListIterator(this, 0);
744 }
745
746 public ListIterator<E> listIterator(int index) {
747 if (index < 0 || index>length)
748 throw indexError(index);
749 return new SubListIterator(this, index);
750 }
751
752 /**
753 * Generic sublist iterator obeying fastfail semantics via
754 * modCount. The hasNext and next methods locally check for
755 * in-range indices before relaying to backing list to get
756 * element. If this either encounters an unexpected modCount or
757 * fails, the backing list must have been concurrently modified,
758 * and is so reported. The add and remove methods performing
759 * structural modifications instead relay them through the
760 * sublist.
761 */
762 private static final class SubListIterator<E> implements ListIterator<E> {
763 final SubList<E> outer; // Sublist creating this iteraor
764 final AbstractList<E> base; // base list
765 final int offset; // Cursor offset wrt base
766 int cursor; // Current index
767 int fence; // Upper bound on cursor
768 int lastRet; // Index of returned element, or -1
769 int expectedModCount; // Expected modCount of base
770
771 SubListIterator(SubList<E> list, int index) {
772 this.lastRet = -1;
773 this.cursor = index;
774 this.outer = list;
775 this.offset = list.baseOffset;
776 this.fence = list.length;
777 this.base = list.base;
778 this.expectedModCount = base.modCount;
779 }
780
781 public boolean hasNext() {
782 return cursor < fence;
783 }
784
785 public boolean hasPrevious() {
786 return cursor > 0;
787 }
788
789 public int nextIndex() {
790 return cursor;
791 }
792
793 public int previousIndex() {
794 return cursor - 1;
795 }
796
797 public E next() {
798 int i = cursor;
799 if (cursor >= fence)
800 throw new NoSuchElementException();
801 if (expectedModCount == base.modCount) {
802 try {
803 Object next = base.get(i + offset);
804 lastRet = i;
805 cursor = i + 1;
806 return (E)next;
807 } catch (IndexOutOfBoundsException fallThrough) {
808 }
809 }
810 throw new ConcurrentModificationException();
811 }
812
813 public E previous() {
814 int i = cursor - 1;
815 if (i < 0)
816 throw new NoSuchElementException();
817 if (expectedModCount == base.modCount) {
818 try {
819 Object prev = base.get(i + offset);
820 lastRet = i;
821 cursor = i;
822 return (E)prev;
823 } catch (IndexOutOfBoundsException fallThrough) {
824 }
825 }
826 throw new ConcurrentModificationException();
827 }
828
829 public void set(E e) {
830 if (lastRet < 0)
831 throw new IllegalStateException();
832 if (expectedModCount != base.modCount)
833 throw new ConcurrentModificationException();
834 try {
835 outer.set(lastRet, e);
836 expectedModCount = base.modCount;
837 } catch (IndexOutOfBoundsException ex) {
838 throw new ConcurrentModificationException();
839 }
840 }
841
842 public void remove() {
843 int i = lastRet;
844 if (i < 0)
845 throw new IllegalStateException();
846 if (expectedModCount != base.modCount)
847 throw new ConcurrentModificationException();
848 try {
849 outer.remove(i);
850 if (i < cursor)
851 cursor--;
852 lastRet = -1;
853 fence = outer.length;
854 expectedModCount = base.modCount;
855 } catch (IndexOutOfBoundsException ex) {
856 throw new ConcurrentModificationException();
857 }
858 }
859
860 public void add(E e) {
861 if (expectedModCount != base.modCount)
862 throw new ConcurrentModificationException();
863 try {
864 int i = cursor;
865 outer.add(i, e);
866 cursor = i + 1;
867 lastRet = -1;
868 fence = outer.length;
869 expectedModCount = base.modCount;
870 } catch (IndexOutOfBoundsException ex) {
871 throw new ConcurrentModificationException();
872 }
873 }
874 }
875
876 }
877
878 class RandomAccessSubList<E> extends SubList<E> implements RandomAccess {
879 RandomAccessSubList(AbstractList<E> base,
880 AbstractList<E> parent, int baseIndex,
881 int fromIndex, int toIndex) {
882 super(base, parent, baseIndex, fromIndex, toIndex);
883 }
884
885 public List<E> subList(int fromIndex, int toIndex) {
886 return new RandomAccessSubList(base, this, fromIndex + baseOffset,
887 fromIndex, toIndex);
888 }
889 }