AbstractList

public abstract class AbstractList extends AbstractCollection<E>
implements List<E>

Known Direct Subclasses AbstractSequentialList<E>, ArrayList<E>, Vector<E> AbstractSequentialList<E> This class provides a skeletal implementation of the List interface to minimize the effort required to implement this interface backed by a "sequential access" data store (such as a linked list).  ArrayList<E> Resizable-array implementation of the List interface.  Vector<E> The Vector class implements a growable array of objects.

Known Indirect Subclasses LinkedList<E>, Stack<E> LinkedList<E> Doubly-linked list implementation of the List and Deque interfaces.  Stack<E> The Stack class represents a last-in-first-out (LIFO) stack of objects.

This class provides a skeletal implementation of the List interface to minimize the effort required to implement this interface backed by a "random access" data store (such as an array). For sequential access data (such as a linked list), AbstractSequentialList should be used in preference to this class.

To implement an unmodifiable list, the programmer needs only to extend this class and provide implementations for the get(int) and 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) methods.

The programmer should generally provide a void (no argument) and collection constructor, as per the recommendation in the Collection interface specification.

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.

Field Summary

protected int

modCount

The number of times this list has been structurally modified.

Protected Constructor Summary

AbstractList() Sole constructor.

Public Method Summary

void	add(int index, E element) Inserts the specified element at the specified position in this list (optional operation).
boolean	add(E e) Appends the specified element to the end of this list (optional operation).
boolean	addAll(int index, Collection<? extends E> c) Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
void	clear() Removes all of the elements from this list (optional operation).
boolean	equals(Object o) Compares the specified object with this list for equality.
abstract E	get(int index) Returns the element at the specified position in this list.
int	hashCode() Returns the hash code value for this list.
int	indexOf(Object o) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
Iterator<E>	iterator() Returns an iterator over the elements in this list in proper sequence.
int	lastIndexOf(Object o) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
ListIterator<E>	listIterator(int index) Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
ListIterator<E>	listIterator() Returns a list iterator over the elements in this list (in proper sequence).
E	remove(int index) Removes the element at the specified position in this list (optional operation).
E	set(int index, E element) Replaces the element at the specified position in this list with the specified element (optional operation).
List<E>	subList(int fromIndex, int toIndex) Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.

Protected Method Summary

void	removeRange(int fromIndex, int toIndex) Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive.

Inherited Method Summary

From class java.util.AbstractCollection

boolean	add(E e) Ensures that this collection contains the specified element (optional operation). This implementation always throws an UnsupportedOperationException.
boolean	addAll(Collection<? extends E> c) Adds all of the elements in the specified collection to this collection (optional operation). This implementation iterates over the specified collection, and adds each object returned by the iterator to this collection, in turn.
void	clear() Removes all of the elements from this collection (optional operation). This implementation iterates over this collection, removing each element using the Iterator.remove operation.
boolean	contains(Object o) Returns true if this collection contains the specified element. This implementation iterates over the elements in the collection, checking each element in turn for equality with the specified element.
boolean	containsAll(Collection<?> c) Returns true if this collection contains all of the elements in the specified collection. This implementation iterates over the specified collection, checking each element returned by the iterator in turn to see if it's contained in this collection.
boolean	isEmpty() Returns true if this collection contains no elements. This implementation returns size() == 0.
abstract Iterator<E>	iterator() Returns an iterator over the elements contained in this collection.
boolean	remove(Object o) Removes a single instance of the specified element from this collection, if it is present (optional operation). This implementation iterates over the collection looking for the specified element.
boolean	removeAll(Collection<?> c) Removes all of this collection's elements that are also contained in the specified collection (optional operation). This implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection.
boolean	retainAll(Collection<?> c) Retains only the elements in this collection that are contained in the specified collection (optional operation). This implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection.
abstract int	size() Returns the number of elements in this collection.
<T> T[]	toArray(T[] contents) Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array. This implementation returns an array containing all the elements returned by this collection's iterator in the same order, stored in consecutive elements of the array, starting with index 0.
Object[]	toArray() Returns an array containing all of the elements in this collection. This implementation returns an array containing all the elements returned by this collection's iterator, in the same order, stored in consecutive elements of the array, starting with index 0.
String	toString() Returns a string representation of this collection.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.util.Collection

abstract boolean	add(E e) Ensures that this collection contains the specified element (optional operation).
abstract boolean	addAll(Collection<? extends E> c) Adds all of the elements in the specified collection to this collection (optional operation).
abstract void	clear() Removes all of the elements from this collection (optional operation).
abstract boolean	contains(Object o) Returns true if this collection contains the specified element.
abstract boolean	containsAll(Collection<?> c) Returns true if this collection contains all of the elements in the specified collection.
abstract boolean	equals(Object o) Compares the specified object with this collection for equality.
abstract int	hashCode() Returns the hash code value for this collection.
abstract boolean	isEmpty() Returns true if this collection contains no elements.
abstract Iterator<E>	iterator() Returns an iterator over the elements in this collection.
Stream<E>	parallelStream() Returns a possibly parallel Stream with this collection as its source.
abstract boolean	remove(Object o) Removes a single instance of the specified element from this collection, if it is present (optional operation).
abstract boolean	removeAll(Collection<?> c) Removes all of this collection's elements that are also contained in the specified collection (optional operation).
boolean	removeIf(Predicate<? super E> filter) Removes all of the elements of this collection that satisfy the given predicate.
abstract boolean	retainAll(Collection<?> c) Retains only the elements in this collection that are contained in the specified collection (optional operation).
abstract int	size() Returns the number of elements in this collection.
Spliterator<E>	spliterator() Creates a Spliterator over the elements in this collection.
Stream<E>	stream() Returns a sequential Stream with this collection as its source.
abstract <T> T[]	toArray(T[] a) Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
abstract Object[]	toArray() Returns an array containing all of the elements in this collection.

From interface java.util.List

abstract boolean	add(E e) Appends the specified element to the end of this list (optional operation).
abstract void	add(int index, E element) Inserts the specified element at the specified position in this list (optional operation).
abstract boolean	addAll(Collection<? extends E> c) Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation).
abstract boolean	addAll(int index, Collection<? extends E> c) Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
abstract void	clear() Removes all of the elements from this list (optional operation).
abstract boolean	contains(Object o) Returns true if this list contains the specified element.
abstract boolean	containsAll(Collection<?> c) Returns true if this list contains all of the elements of the specified collection.
abstract boolean	equals(Object o) Compares the specified object with this list for equality.
abstract E	get(int index) Returns the element at the specified position in this list.
abstract int	hashCode() Returns the hash code value for this list.
abstract int	indexOf(Object o) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
abstract boolean	isEmpty() Returns true if this list contains no elements.
abstract Iterator<E>	iterator() Returns an iterator over the elements in this list in proper sequence.
abstract int	lastIndexOf(Object o) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
abstract ListIterator<E>	listIterator(int index) Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.
abstract ListIterator<E>	listIterator() Returns a list iterator over the elements in this list (in proper sequence).
abstract E	remove(int index) Removes the element at the specified position in this list (optional operation).
abstract boolean	remove(Object o) Removes the first occurrence of the specified element from this list, if it is present (optional operation).
abstract boolean	removeAll(Collection<?> c) Removes from this list all of its elements that are contained in the specified collection (optional operation).
void	replaceAll(UnaryOperator<E> operator) Replaces each element of this list with the result of applying the operator to that element.
abstract boolean	retainAll(Collection<?> c) Retains only the elements in this list that are contained in the specified collection (optional operation).
abstract E	set(int index, E element) Replaces the element at the specified position in this list with the specified element (optional operation).
abstract int	size() Returns the number of elements in this list.
void	sort(Comparator<? super E> c) Sorts this list according to the order induced by the specified Comparator.
Spliterator<E>	spliterator() Creates a Spliterator over the elements in this list.
abstract List<E>	subList(int fromIndex, int toIndex) Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
abstract Object[]	toArray() Returns an array containing all of the elements in this list in proper sequence (from first to last element).
abstract <T> T[]	toArray(T[] a) Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array.

From interface java.lang.Iterable

void	forEach(Consumer<? super T> action) Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception.
abstract Iterator<E>	iterator() Returns an iterator over elements of type T.
Spliterator<E>	spliterator() Creates a Spliterator over the elements described by this Iterable.

Fields

protected int modCount

The number of times this list has been structurally modified. Structural modifications are those that change the size of the list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.

This 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.

Protected Constructors

protected AbstractList ()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Public Methods

public void add (int index, E element)

Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Parameters

index	index at which the specified element is to be inserted
element	element to be inserted

Throws

UnsupportedOperationException
ClassCastException
NullPointerException
IllegalArgumentException
IndexOutOfBoundsException

public boolean add (E e)

Appends the specified element to the end of this list (optional operation).

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.

Parameters

e	element to be appended to this list

Returns

• true (as specified by Collection.add(E))

Throws

UnsupportedOperationException	if the add operation is not supported by this list
ClassCastException	if the class of the specified element prevents it from being added to this list
NullPointerException	if the specified element is null and this list does not permit null elements
IllegalArgumentException	if some property of this element prevents it from being added to this list

public boolean addAll (int index, Collection<? extends E> c)

Inserts all of the elements in the specified collection into this list at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)

Parameters

index	index at which to insert the first element from the specified collection
c	collection containing elements to be added to this list

Returns

• true if this list changed as a result of the call

Throws

UnsupportedOperationException
ClassCastException
NullPointerException
IllegalArgumentException
IndexOutOfBoundsException

public void clear ()

Removes all of the elements from this list (optional operation). The list will be empty after this call returns.

Throws

UnsupportedOperationException	if the clear operation is not supported by this list

public boolean equals (Object o)

Compares the specified object with this list for equality. Returns 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.

Parameters

o	the object to be compared for equality with this list

Returns

• true if the specified object is equal to this list

public abstract E get (int index)

Returns the element at the specified position in this list.

Parameters

index	index of the element to return

Returns

• the element at the specified position in this list

Throws

IndexOutOfBoundsException

public int hashCode ()

Returns the hash code value for this list.

Returns

• the hash code value for this list

public int indexOf (Object o)

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index i such that Objects.equals(o, get(i)), or -1 if there is no such index.

Parameters

o	element to search for

Returns

• the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element

Throws

ClassCastException
NullPointerException

public Iterator<E> iterator ()

Returns an iterator over the elements in this list in proper sequence.

Returns

• an iterator over the elements in this list in proper sequence

public int lastIndexOf (Object o)

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest index i such that Objects.equals(o, get(i)), or -1 if there is no such index.

Parameters

o	element to search for

Returns

• the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element

Throws

ClassCastException
NullPointerException

public ListIterator<E> listIterator (int index)

Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list. The specified index indicates the first element that would be returned by an initial call to next. An initial call to previous would return the element with the specified index minus one.

Parameters

index	index of the first element to be returned from the list iterator (by a call to next)

Returns

• a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list

Throws

IndexOutOfBoundsException

public ListIterator<E> listIterator ()

Returns a list iterator over the elements in this list (in proper sequence).

Returns

• a list iterator over the elements in this list (in proper sequence)

See Also

• listIterator(int)

public E remove (int index)

Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.

Parameters

index	the index of the element to be removed

Returns

• the element previously at the specified position

Throws

UnsupportedOperationException
IndexOutOfBoundsException

public E set (int index, E element)

Replaces the element at the specified position in this list with the specified element (optional operation).

Parameters

index	index of the element to replace
element	element to be stored at the specified position

Returns

• the element previously at the specified position

Throws

UnsupportedOperationException
ClassCastException
NullPointerException
IllegalArgumentException
IndexOutOfBoundsException

public List<E> subList (int fromIndex, int toIndex)

Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations supported by this list.

This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list:

list.subList(from, to).clear();
 

Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the Collections class can be applied to a subList.

The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)

Parameters

fromIndex	low endpoint (inclusive) of the subList
toIndex	high endpoint (exclusive) of the subList

Returns

• a view of the specified range within this list

Throws

IndexOutOfBoundsException	if an endpoint index value is out of range (fromIndex < 0 || toIndex > size)
IllegalArgumentException	if the endpoint indices are out of order (fromIndex > toIndex)

Protected Methods

protected void removeRange (int fromIndex, int toIndex)

Removes from this list all of the elements whose index is between 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.

Parameters

fromIndex	index of first element to be removed
toIndex	index after last element to be removed