ListAbstractSequentialListTo implement an unmodifiable list, the programmer needs only to extend
this class and provide implementations for the get(int)size() methods.
To implement a modifiable list, the programmer must additionally
override the set(int, E) method (which otherwise
throws an UnsupportedOperationException). If the list is
variable-size the programmer must additionally override the
add(int, E) and remove(int)
The programmer should generally provide a void (no argument) and collection
constructor, as per the recommendation in the Collection
Unlike the other abstract collection implementations, the programmer does
not have to provide an iterator implementation; the iterator and
list iterator are implemented by this class, on top of the "random access"
methods:
get(int)set(int, E),
add(int, E) and
remove(int)
The documentation for each non-abstract method in this class describes its implementation in detail. Each of these methods may be overridden if the collection being implemented admits a more efficient implementation.
This class is a member of the Java Collections Framework.
Lists that support this operation may place limitations on what elements may be added to this list. In particular, some lists will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. List classes should clearly specify in their documentation any restrictions on what elements may be added.
This implementation calls add(size(), e).
Note that this implementation throws an
UnsupportedOperationException unless
add(int, E) is overridden.
e element to be appended to this listtrue (as specified by Collection.add(java.lang.Object)java.lang.UnsupportedOperationException if the add operation
is not supported by this listjava.lang.ClassCastException if the class of the specified element
prevents it from being added to this listjava.lang.NullPointerException if the specified element is null and this
list does not permit null elementsjava.lang.IllegalArgumentException if some property of this element
prevents it from being added to this listThis implementation calls removeRange(0, size()).
Note that this implementation throws an
UnsupportedOperationException unless remove(int
index) or removeRange(int fromIndex, int toIndex) is
overridden.
java.lang.UnsupportedOperationException if the clear operation
is not supported by this listThis implementation gets an iterator over the specified collection
and iterates over it, inserting the elements obtained from the
iterator into this list at the appropriate position, one at a time,
using add(int, E).
Many implementations will override this method for efficiency.
Note that this implementation throws an
UnsupportedOperationException unless
add(int, E) is overridden.
This implementation returns a straightforward implementation of the
iterator interface, relying on the backing list's size(),
get(int), and remove(int) methods.
Note that the iterator returned by this method will throw an
java.lang.UnsupportedOperationExceptionremove method unless the list's remove(int) method is
overridden.
This implementation can be made to throw runtime exceptions in the
face of concurrent modification, as described in the specification
for the (protected) modCount
This implementation returns a straightforward implementation of the
ListIterator interface that extends the implementation of the
Iterator interface returned by the iterator() method.
The ListIterator implementation relies on the backing list's
get(int), set(int, E), add(int, E)
and remove(int) methods.
Note that the list iterator returned by this implementation will
throw an java.lang.UnsupportedOperationExceptionremove, set and add methods unless the
list's remove(int), set(int, E), and
add(int, E) methods are overridden.
This implementation can be made to throw runtime exceptions in the
face of concurrent modification, as described in the specification for
the (protected) modCount
This implementation returns a list that subclasses
AbstractList. The subclass stores, in private fields, the
offset of the subList within the backing list, the size of the subList
(which can change over its lifetime), and the expected
modCount value of the backing list. There are two variants
of the subclass, one of which implements RandomAccess.
If this list implements RandomAccess the returned list will
be an instance of the subclass that implements RandomAccess.
The subclass's set(int, E), get(int),
add(int, E), remove(int), addAll(int,
Collection) and removeRange(int, int) methods all
delegate to the corresponding methods on the backing abstract list,
after bounds-checking the index and adjusting for the offset. The
addAll(Collection c) method merely returns addAll(size,
c).
The listIterator(int) method returns a "wrapper object"
over a list iterator on the backing list, which is created with the
corresponding method on the backing list. The iterator method
merely returns listIterator(), and the size method
merely returns the subclass's size field.
All methods first check to see if the actual modCount of
the backing list is equal to its expected value, and throw a
ConcurrentModificationException if it is not.
java.lang.IndexOutOfBoundsException if an endpoint index value is out of range
(fromIndex < 0 || toIndex > size)java.lang.IllegalArgumentException if the endpoint indices are out of order
(fromIndex > toIndex)true if and only if the specified object is also a list, both
lists have the same size, and all corresponding pairs of elements in
the two lists are equal. (Two elements e1 and
e2 are equal if (e1==null ? e2==null :
e1.equals(e2)).) In other words, two lists are defined to be
equal if they contain the same elements in the same order.
This implementation first checks if the specified object is this
list. If so, it returns true; if not, it checks if the
specified object is a list. If not, it returns false; if so,
it iterates over both lists, comparing corresponding pairs of elements.
If any comparison returns false, this method returns
false. If either iterator runs out of elements before the
other it returns false (as the lists are of unequal length);
otherwise it returns true when the iterations complete.
o the object to be compared for equality with this listtrue if the specified object is equal to this listThis implementation uses exactly the code that is used to define the
list hash function in the documentation for the List.hashCode()
fromIndex, inclusive, and toIndex, exclusive.
Shifts any succeeding elements to the left (reduces their index).
This call shortens the list by (toIndex - fromIndex) elements.
(If toIndex==fromIndex, this operation has no effect.)
This method is called by the clear operation on this list
and its subLists. Overriding this method to take advantage of
the internals of the list implementation can substantially
improve the performance of the clear operation on this list
and its subLists.
This implementation gets a list iterator positioned before
fromIndex, and repeatedly calls ListIterator.next
followed by ListIterator.remove until the entire range has
been removed. Note: if ListIterator.remove requires linear
time, this implementation requires quadratic time.
fromIndex index of first element to be removedtoIndex index after last element to be removedThis field is used by the iterator and list iterator implementation
returned by the iterator and listIterator methods.
If the value of this field changes unexpectedly, the iterator (or list
iterator) will throw a ConcurrentModificationException in
response to the next, remove, previous,
set or add operations. This provides
fail-fast behavior, rather than non-deterministic behavior in
the face of concurrent modification during iteration.
Use of this field by subclasses is optional. If a subclass
wishes to provide fail-fast iterators (and list iterators), then it
merely has to increment this field in its add(int, E) and
remove(int) methods (and any other methods that it overrides
that result in structural modifications to the list). A single call to
add(int, E) or remove(int) must add no more than
one to this field, or the iterators (and list iterators) will throw
bogus ConcurrentModificationExceptions. If an implementation
does not wish to provide fail-fast iterators, this field may be
ignored.