ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/main/java/util/AbstractList.java
Revision: 1.13
Committed: Mon Jun 26 01:02:38 2006 UTC (17 years, 11 months ago) by jsr166
Branch: MAIN
Changes since 1.12: +49 -50 lines
Log Message:
doc sync with mustang

File Contents

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