ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/main/java/util/AbstractList.java
(Generate patch)

Comparing jsr166/src/main/java/util/AbstractList.java (file contents):
Revision 1.11 by jsr166, Sun May 28 23:36:29 2006 UTC vs.
Revision 1.13 by jsr166, Mon Jun 26 01:02:38 2006 UTC

# Line 8 | Line 8
8   package java.util;
9  
10   /**
11 < * This class provides a skeletal implementation of the <tt>List</tt>
11 > * This class provides a skeletal implementation of the {@link List}
12   * 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 < * access data (such as a linked list), <tt>AbstractSequentialList</tt> should
15 < * be used in preference to this class.<p>
14 > * access data (such as a linked list), {@link AbstractSequentialList} should
15 > * be used in preference to this class.
16   *
17 < * To implement an unmodifiable list, the programmer needs only to extend this
18 < * class and provide implementations for the <tt>get(int index)</tt> and
19 < * <tt>size()</tt> methods.<p>
17 > * <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   *
21 < * To implement a modifiable list, the programmer must additionally override
22 < * the <tt>set(int index, Object element)</tt> method (which otherwise throws
23 < * an <tt>UnsupportedOperationException</tt>.  If the list is variable-size
24 < * the programmer must additionally override the <tt>add(int index, Object
25 < * element)</tt> and <tt>remove(int index)</tt> methods.<p>
21 > * <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   *
27 < * The programmer should generally provide a void (no argument) and collection
28 < * constructor, as per the recommendation in the <tt>Collection</tt> interface
29 < * specification.<p>
27 > * <p>The programmer should generally provide a void (no argument) and collection
28 > * constructor, as per the recommendation in the {@link Collection} interface
29 > * specification.
30   *
31 < * Unlike the other abstract collection implementations, the programmer does
31 > * <p>Unlike the other abstract collection implementations, the programmer does
32   * <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 < * methods: <tt>get(int index)</tt>, <tt>set(int index, E element)</tt>,
35 < * <tt>add(int index, E element)</tt> and <tt>remove(int index)</tt>.<p>
34 > * 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   *
40 < * The documentation for each non-abstract methods in this class describes its
40 > * <p>The documentation for each non-abstract method in this class describes its
41   * implementation in detail.  Each of these methods may be overridden if the
42 < * collection being implemented admits a more efficient implementation.<p>
42 > * collection being implemented admits a more efficient implementation.
43   *
44 < * This class is a member of the
44 > * <p>This class is a member of the
45   * <a href="{@docRoot}/../technotes/guides/collections/index.html">
46   * Java Collections Framework</a>.
47   *
48   * @author  Josh Bloch
49   * @author  Neal Gafter
50   * @version %I%, %G%
48 * @see Collection
49 * @see List
50 * @see AbstractSequentialList
51 * @see AbstractCollection
51   * @since 1.2
52   */
53  
# Line 71 | Line 70 | public abstract class AbstractList<E> ex
70       * classes should clearly specify in their documentation any restrictions
71       * on what elements may be added.
72       *
73 <     * <p>This implementation calls <tt>add(size(), e)</tt>.
73 >     * <p>This implementation calls {@code add(size(), e)}.
74       *
75       * <p>Note that this implementation throws an
76 <     * <tt>UnsupportedOperationException</tt> unless <tt>add(int, Object)</tt>
77 <     * is overridden.
76 >     * {@code UnsupportedOperationException} unless
77 >     * {@link #add(int, Object) add(int, E)} is overridden.
78       *
79       * @param e element to be appended to this list
80 <     * @return <tt>true</tt> (as specified by {@link Collection#add})
81 <     * @throws UnsupportedOperationException if the <tt>add</tt> operation
80 >     * @return {@code true} (as specified by {@link Collection#add})
81 >     * @throws UnsupportedOperationException if the {@code add} operation
82       *         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
# Line 104 | Line 103 | public abstract class AbstractList<E> ex
103       * {@inheritDoc}
104       *
105       * <p>This implementation always throws an
106 <     * <tt>UnsupportedOperationException</tt>.
106 >     * {@code UnsupportedOperationException}.
107       *
108       * @throws UnsupportedOperationException {@inheritDoc}
109       * @throws ClassCastException            {@inheritDoc}
# Line 120 | Line 119 | public abstract class AbstractList<E> ex
119       * {@inheritDoc}
120       *
121       * <p>This implementation always throws an
122 <     * <tt>UnsupportedOperationException</tt>.
122 >     * {@code UnsupportedOperationException}.
123       *
124       * @throws UnsupportedOperationException {@inheritDoc}
125       * @throws ClassCastException            {@inheritDoc}
# Line 136 | Line 135 | public abstract class AbstractList<E> ex
135       * {@inheritDoc}
136       *
137       * <p>This implementation always throws an
138 <     * <tt>UnsupportedOperationException</tt>.
138 >     * {@code UnsupportedOperationException}.
139       *
140       * @throws UnsupportedOperationException {@inheritDoc}
141       * @throws IndexOutOfBoundsException     {@inheritDoc}
# Line 152 | Line 151 | public abstract class AbstractList<E> ex
151       * {@inheritDoc}
152       *
153       * <p>This implementation first gets a list iterator (with
154 <     * <tt>listIterator()</tt>).  Then, it iterates over the list until the
154 >     * {@code listIterator()}).  Then, it iterates over the list until the
155       * specified element is found or the end of the list is reached.
156       *
157       * @throws ClassCastException   {@inheritDoc}
# Line 176 | Line 175 | public abstract class AbstractList<E> ex
175       * {@inheritDoc}
176       *
177       * <p>This implementation first gets a list iterator that points to the end
178 <     * of the list (with <tt>listIterator(size())</tt>).  Then, it iterates
178 >     * of the list (with {@code listIterator(size())}).  Then, it iterates
179       * backwards over the list until the specified element is found, or the
180       * beginning of the list is reached.
181       *
# Line 204 | Line 203 | public abstract class AbstractList<E> ex
203       * Removes all of the elements from this list (optional operation).
204       * The list will be empty after this call returns.
205       *
206 <     * <p>This implementation calls <tt>removeRange(0, size())</tt>.
206 >     * <p>This implementation calls {@code removeRange(0, size())}.
207       *
208       * <p>Note that this implementation throws an
209 <     * <tt>UnsupportedOperationException</tt> unless <tt>remove(int
210 <     * index)</tt> or <tt>removeRange(int fromIndex, int toIndex)</tt> is
209 >     * {@code UnsupportedOperationException} unless {@code remove(int
210 >     * index)} or {@code removeRange(int fromIndex, int toIndex)} is
211       * overridden.
212       *
213 <     * @throws UnsupportedOperationException if the <tt>clear</tt> operation
213 >     * @throws UnsupportedOperationException if the {@code clear} operation
214       *         is not supported by this list
215       */
216      public void clear() {
# Line 221 | Line 220 | public abstract class AbstractList<E> ex
220      /**
221       * {@inheritDoc}
222       *
223 <     * <p>This implementation gets an iterator over the specified collection and
224 <     * iterates over it, inserting the elements obtained from the iterator
225 <     * into this list at the appropriate position, one at a time, using
226 <     * <tt>add(int, Object)</tt>.  Many implementations will override this
227 <     * method for efficiency.
223 >     * <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       *
229       * <p>Note that this implementation throws an
230 <     * <tt>UnsupportedOperationException</tt> unless <tt>add(int, Object)</tt>
231 <     * is overridden.
230 >     * {@code UnsupportedOperationException} unless
231 >     * {@link #add(int, Object) add(int, E)} is overridden.
232       *
233       * @throws UnsupportedOperationException {@inheritDoc}
234       * @throws ClassCastException            {@inheritDoc}
# Line 252 | Line 251 | public abstract class AbstractList<E> ex
251  
252      /**
253       * Returns an iterator over the elements in this list in proper
254 <     * sequence. <p>
254 >     * sequence.
255       *
256 <     * This implementation returns a straightforward implementation of the
257 <     * iterator interface, relying on the backing list's <tt>size()</tt>,
258 <     * <tt>get(int)</tt>, and <tt>remove(int)</tt> methods.<p>
259 <     *
260 <     * Note that the iterator returned by this method will throw an
261 <     * <tt>UnsupportedOperationException</tt> in response to its
262 <     * <tt>remove</tt> method unless the list's <tt>remove(int)</tt> method is
263 <     * overridden.<p>
264 <     *
265 <     * This implementation can be made to throw runtime exceptions in the face
266 <     * of concurrent modification, as described in the specification for the
267 <     * (protected) <tt>modCount</tt> field.
256 >     * <p>This implementation returns a straightforward implementation of the
257 >     * iterator interface, relying on the backing list's {@code size()},
258 >     * {@code get(int)}, and {@code remove(int)} methods.
259 >     *
260 >     * <p>Note that the iterator returned by this method will throw an
261 >     * {@code UnsupportedOperationException} in response to its
262 >     * {@code remove} method unless the list's {@code remove(int)} method is
263 >     * overridden.
264 >     *
265 >     * <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       *
269       * @return an iterator over the elements in this list in proper sequence
270       *
# Line 278 | Line 277 | public abstract class AbstractList<E> ex
277      /**
278       * {@inheritDoc}
279       *
280 <     * <p>This implementation returns <tt>listIterator(0)</tt>.
280 >     * <p>This implementation returns {@code listIterator(0)}.
281       *
282       * @see #listIterator(int)
283       */
# Line 290 | Line 289 | public abstract class AbstractList<E> ex
289       * {@inheritDoc}
290       *
291       * <p>This implementation returns a straightforward implementation of the
292 <     * <tt>ListIterator</tt> interface that extends the implementation of the
293 <     * <tt>Iterator</tt> interface returned by the <tt>iterator()</tt> method.
294 <     * The <tt>ListIterator</tt> implementation relies on the backing list's
295 <     * <tt>get(int)</tt>, <tt>set(int, Object)</tt>, <tt>add(int, Object)</tt>
296 <     * and <tt>remove(int)</tt> methods.
292 >     * {@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 >     * {@code get(int)}, {@code set(int, E)}, {@code add(int, Object)}
296 >     * and {@code remove(int)} methods.
297       *
298       * <p>Note that the list iterator returned by this implementation will
299 <     * throw an <tt>UnsupportedOperationException</tt> in response to its
300 <     * <tt>remove</tt>, <tt>set</tt> and <tt>add</tt> methods unless the
301 <     * list's <tt>remove(int)</tt>, <tt>set(int, Object)</tt>, and
302 <     * <tt>add(int, Object)</tt> methods are overridden.
299 >     * throw an {@code UnsupportedOperationException} in response to its
300 >     * {@code remove}, {@code set} and {@code add} methods unless the
301 >     * list's {@code remove(int)}, {@code set(int, E)}, and
302 >     * {@code add(int, E)} methods are overridden.
303       *
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 <     * the (protected) <tt>modCount</tt> field.
306 >     * the (protected) {@code modCount} field.
307       *
308       * @throws IndexOutOfBoundsException {@inheritDoc}
309       *
# Line 437 | Line 436 | public abstract class AbstractList<E> ex
436       * {@inheritDoc}
437       *
438       * <p>This implementation returns a list that subclasses
439 <     * <tt>AbstractList</tt>.  The subclass stores, in private fields, the
439 >     * {@code AbstractList}.  The subclass stores, in private fields, the
440       * offset of the subList within the backing list, the size of the subList
441       * (which can change over its lifetime), and the expected
442 <     * <tt>modCount</tt> value of the backing list.  There are two variants
443 <     * of the subclass, one of which implements <tt>RandomAccess</tt>.
444 <     * If this list implements <tt>RandomAccess</tt> the returned list will
445 <     * be an instance of the subclass that implements <tt>RandomAccess</tt>.
446 <     *
447 <     * <p>The subclass's <tt>set(int, Object)</tt>, <tt>get(int)</tt>,
448 <     * <tt>add(int, Object)</tt>, <tt>remove(int)</tt>, <tt>addAll(int,
449 <     * Collection)</tt> and <tt>removeRange(int, int)</tt> methods all
442 >     * {@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       * delegate to the corresponding methods on the backing abstract list,
451       * after bounds-checking the index and adjusting for the offset.  The
452 <     * <tt>addAll(Collection c)</tt> method merely returns <tt>addAll(size,
453 <     * c)</tt>.
452 >     * {@code addAll(Collection c)} method merely returns {@code addAll(size,
453 >     * c)}.
454       *
455 <     * <p>The <tt>listIterator(int)</tt> method returns a "wrapper object"
455 >     * <p>The {@code listIterator(int)} method returns a "wrapper object"
456       * over a list iterator on the backing list, which is created with the
457 <     * corresponding method on the backing list.  The <tt>iterator</tt> method
458 <     * merely returns <tt>listIterator()</tt>, and the <tt>size</tt> method
459 <     * merely returns the subclass's <tt>size</tt> field.
457 >     * 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       *
461 <     * <p>All methods first check to see if the actual <tt>modCount</tt> of
461 >     * <p>All methods first check to see if the actual {@code modCount} of
462       * the backing list is equal to its expected value, and throw a
463 <     * <tt>ConcurrentModificationException</tt> if it is not.
463 >     * {@code ConcurrentModificationException} if it is not.
464       *
465       * @throws IndexOutOfBoundsException endpoint index value out of range
466 <     *         <tt>(fromIndex &lt; 0 || toIndex &gt; size)</tt>
466 >     *         {@code (fromIndex &lt; 0 || toIndex &gt; size)}
467       * @throws IllegalArgumentException if the endpoint indices are out of order
468 <     *         <tt>(fromIndex &gt; toIndex)</tt>
468 >     *         {@code (fromIndex &gt; toIndex)}
469       */
470      public List<E> subList(int fromIndex, int toIndex) {
471          return (this instanceof RandomAccess ?
# Line 478 | Line 477 | public abstract class AbstractList<E> ex
477  
478      /**
479       * Compares the specified object with this list for equality.  Returns
480 <     * <tt>true</tt> if and only if the specified object is also a list, both
480 >     * {@code true} if and only if the specified object is also a list, both
481       * lists have the same size, and all corresponding pairs of elements in
482 <     * the two lists are <i>equal</i>.  (Two elements <tt>e1</tt> and
483 <     * <tt>e2</tt> are <i>equal</i> if <tt>(e1==null ? e2==null :
484 <     * e1.equals(e2))</tt>.)  In other words, two lists are defined to be
485 <     * equal if they contain the same elements in the same order.<p>
486 <     *
487 <     * This implementation first checks if the specified object is this
488 <     * list. If so, it returns <tt>true</tt>; if not, it checks if the
489 <     * specified object is a list. If not, it returns <tt>false</tt>; if so,
482 >     * 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 >     * equal if they contain the same elements in the same order.
486 >     *
487 >     * <p>This implementation first checks if the specified object is this
488 >     * 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       * it iterates over both lists, comparing corresponding pairs of elements.
491 <     * If any comparison returns <tt>false</tt>, this method returns
492 <     * <tt>false</tt>.  If either iterator runs out of elements before the
493 <     * other it returns <tt>false</tt> (as the lists are of unequal length);
494 <     * otherwise it returns <tt>true</tt> when the iterations complete.
491 >     * 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       *
496       * @param o the object to be compared for equality with this list
497 <     * @return <tt>true</tt> if the specified object is equal to this list
497 >     * @return {@code true} if the specified object is equal to this list
498       */
499      public boolean equals(Object o) {
500          if (o == this)
# Line 515 | Line 514 | public abstract class AbstractList<E> ex
514      }
515  
516      /**
517 <     * Returns the hash code value for this list. <p>
517 >     * Returns the hash code value for this list.
518       *
519 <     * This implementation uses exactly the code that is used to define the
519 >     * <p>This implementation uses exactly the code that is used to define the
520       * list hash function in the documentation for the {@link List#hashCode}
521       * method.
522       *
# Line 535 | Line 534 | public abstract class AbstractList<E> ex
534  
535      /**
536       * Removes from this list all of the elements whose index is between
537 <     * <tt>fromIndex</tt>, inclusive, and <tt>toIndex</tt>, exclusive.
537 >     * {@code fromIndex}, inclusive, and {@code toIndex}, exclusive.
538       * Shifts any succeeding elements to the left (reduces their index).
539 <     * This call shortens the ArrayList by <tt>(toIndex - fromIndex)</tt>
540 <     * elements.  (If <tt>toIndex==fromIndex</tt>, this operation has no
541 <     * effect.)<p>
539 >     * This call shortens the ArrayList by {@code (toIndex - fromIndex)}
540 >     * elements.  (If {@code toIndex==fromIndex}, this operation has no
541 >     * effect.)
542       *
543 <     * This method is called by the <tt>clear</tt> operation on this list
543 >     * <p>This method is called by the {@code clear} operation on this list
544       * and its subLists.  Overriding this method to take advantage of
545       * the internals of the list implementation can <i>substantially</i>
546 <     * improve the performance of the <tt>clear</tt> operation on this list
547 <     * and its subLists.<p>
546 >     * improve the performance of the {@code clear} operation on this list
547 >     * and its subLists.
548       *
549 <     * This implementation gets a list iterator positioned before
550 <     * <tt>fromIndex</tt>, and repeatedly calls <tt>ListIterator.next</tt>
551 <     * followed by <tt>ListIterator.remove</tt> until the entire range has
552 <     * been removed.  <b>Note: if <tt>ListIterator.remove</tt> requires linear
549 >     * <p>This implementation gets a list iterator positioned before
550 >     * {@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       * time, this implementation requires quadratic time.</b>
554       *
555       * @param fromIndex index of first element to be removed
# Line 568 | Line 567 | public abstract class AbstractList<E> ex
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 <     * progress may yield incorrect results.<p>
570 >     * progress may yield incorrect results.
571       *
572 <     * This field is used by the iterator and list iterator implementation
573 <     * returned by the <tt>iterator</tt> and <tt>listIterator</tt> methods.
572 >     * <p>This field is used by the iterator and list iterator implementation
573 >     * returned by the {@code iterator} and {@code listIterator} methods.
574       * If the value of this field changes unexpectedly, the iterator (or list
575 <     * iterator) will throw a <tt>ConcurrentModificationException</tt> in
576 <     * response to the <tt>next</tt>, <tt>remove</tt>, <tt>previous</tt>,
577 <     * <tt>set</tt> or <tt>add</tt> operations.  This provides
575 >     * 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       * <i>fail-fast</i> behavior, rather than non-deterministic behavior in
579 <     * the face of concurrent modification during iteration.<p>
579 >     * the face of concurrent modification during iteration.
580       *
581 <     * <b>Use of this field by subclasses is optional.</b> If a subclass
581 >     * <p><b>Use of this field by subclasses is optional.</b> If a subclass
582       * wishes to provide fail-fast iterators (and list iterators), then it
583 <     * merely has to increment this field in its <tt>add(int, Object)</tt> and
584 <     * <tt>remove(int)</tt> methods (and any other methods that it overrides
583 >     * 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       * that result in structural modifications to the list).  A single call to
586 <     * <tt>add(int, Object)</tt> or <tt>remove(int)</tt> must add no more than
586 >     * {@code add(int, Object)} or {@code remove(int)} must add no more than
587       * one to this field, or the iterators (and list iterators) will throw
588 <     * bogus <tt>ConcurrentModificationExceptions</tt>.  If an implementation
588 >     * bogus {@code ConcurrentModificationExceptions}.  If an implementation
589       * does not wish to provide fail-fast iterators, this field may be
590       * ignored.
591       */

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines