OpenJDK 1.22 · java.util.AbstractSequentialList · APIdia, the JavaDoc alternative

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). For random access data (such as an array), AbstractList should be used in preference to this class.

This class is the opposite of the AbstractList class in the sense that it implements the "random access" methods (get(int index), set(int index, E element), add(int index, E element) and remove(int index)) on top of the list's list iterator, instead of the other way around.

To implement a list the programmer needs only to extend this class and provide implementations for the listIterator and size methods. For an unmodifiable list, the programmer need only implement the list iterator's hasNext, next, hasPrevious, previous and index methods.

For a modifiable list the programmer should additionally implement the list iterator's set method. For a variable-size list the programmer should additionally implement the list iterator's remove and add methods.

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

This class is a member of the Java Collections Framework.

Access	Constructor and Description
protected	AbstractSequentialList() Sole constructor.

Method Summary

Modifier and Type	Method and Description
public void	add(int index at which the specified element is to be inserted index, E element to be inserted element) Overrides java.util.AbstractList.add. Implements java.util.List.add. Inserts the specified element at the specified position in this list (optional operation).
public boolean	addAll(int index at which to insert the first element from the specified collection index, Collection<? extends E> collection containing elements to be added to this list c) Overrides java.util.AbstractList.addAll. Implements java.util.List.addAll. Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
public E	get(int index of the element to return index) Implements abstract java.util.AbstractList.get. Implements java.util.List.get. Returns the element at the specified position in this list.
public Iterator<E>	Returns: an iterator over the elements in this list (in proper sequence) iterator() Overrides java.util.AbstractList.iterator. Implements java.util.List.iterator, java.util.Collection.iterator. Returns an iterator over the elements in this list (in proper sequence).
public abstract ListIterator<E>	Returns: a list iterator over the elements in this list (in proper sequence) listIterator(int index of first element to be returned from the list iterator (by a call to the `next` method) index) Redeclares java.util.List.listIterator. Overrides java.util.AbstractList.listIterator. Returns a list iterator over the elements in this list (in proper sequence).
public E	remove(int the index of the element to be removed index) Overrides java.util.AbstractList.remove. Implements java.util.List.remove. Removes the element at the specified position in this list (optional operation).
public E	set(int index of the element to replace index, E element to be stored at the specified position element) Overrides java.util.AbstractList.set. Implements java.util.List.set. Replaces the element at the specified position in this list with the specified element (optional operation).

Inherited from java.util.AbstractList:: add clear equals hashCode indexOf lastIndexOf listIterator removeRange subList subListRangeCheck

Constructor Detail

AbstractSequentialList	back to summary
protected AbstractSequentialList() Sole constructor. (For invocation by subclass constructors, typically implicit.)

Method Detail

add back to summary

add	back to summary
public void add(int index, E element) Overrides java.util.AbstractList.add. Implements java.util.List.add. 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). This implementation first gets a list iterator pointing to the indexed element (with `listIterator(index)`). Then, it inserts the specified element with `ListIterator.add`. Note that this implementation will throw an `UnsupportedOperationException` if the list iterator does not implement the `add` operation. Parameters index:int Doc from java.util.List.add. index at which the specified element is to be inserted element:E Doc from java.util.List.add. element to be inserted Exceptions 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 the specified element prevents it from being added to this list IndexOutOfBoundsException: if the index is out of range (`index < 0 \|\| index > size()`)

public void add(int index, E element)

Overrides java.util.AbstractList.add.

Implements java.util.List.add.

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

This implementation first gets a list iterator pointing to the indexed element (with listIterator(index)). Then, it inserts the specified element with ListIterator.add.

Note that this implementation will throw an UnsupportedOperationException if the list iterator does not implement the add operation.

Parameters

index:int

Doc from java.util.List.add.

index at which the specified element is to be inserted

element:E

Doc from java.util.List.add.

element to be inserted

Exceptions

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 the specified element prevents it from being added to this list
IndexOutOfBoundsException:: if the index is out of range (index < 0 || index > size())

addAll back to summary

addAll	back to summary
public boolean addAll(int index, Collection<? extends E> c) Overrides java.util.AbstractList.addAll. Implements java.util.List.addAll. 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.) This implementation gets an iterator over the specified collection and a list iterator over this list pointing to the indexed element (with `listIterator(index)`). Then, it iterates over the specified collection, inserting the elements obtained from the iterator into this list, one at a time, using `ListIterator.add` followed by `ListIterator.next` (to skip over the added element). Note that this implementation will throw an `UnsupportedOperationException` if the list iterator returned by the `listIterator` method does not implement the `add` operation. Parameters index:int Doc from java.util.List.addAll. index at which to insert the first element from the specified collection c:Collection<? extends E> Doc from java.util.List.addAll. collection containing elements to be added to this list Returns:boolean Doc from java.util.List.addAll. `true` if this list changed as a result of the call Exceptions UnsupportedOperationException: if the `addAll` operation is not supported by this list ClassCastException: if the class of an element of the specified collection prevents it from being added to this list NullPointerException: if the specified collection contains one or more null elements and this list does not permit null elements, or if the specified collection is null IllegalArgumentException: if some property of an element of the specified collection prevents it from being added to this list IndexOutOfBoundsException: if the index is out of range (`index < 0 \|\| index > size()`)

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

Overrides java.util.AbstractList.addAll.

Implements java.util.List.addAll.

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

This implementation gets an iterator over the specified collection and a list iterator over this list pointing to the indexed element (with listIterator(index)). Then, it iterates over the specified collection, inserting the elements obtained from the iterator into this list, one at a time, using ListIterator.add followed by ListIterator.next (to skip over the added element).

Note that this implementation will throw an UnsupportedOperationException if the list iterator returned by the listIterator method does not implement the add operation.

Parameters

index:int

Doc from java.util.List.addAll.

index at which to insert the first element from the specified collection

c:Collection<? extends E>

Doc from java.util.List.addAll.

collection containing elements to be added to this list

Returns:boolean

Doc from java.util.List.addAll.

true if this list changed as a result of the call

Exceptions

UnsupportedOperationException:: if the addAll operation is not supported by this list
ClassCastException:: if the class of an element of the specified collection prevents it from being added to this list
NullPointerException:: if the specified collection contains one or more null elements and this list does not permit null elements, or if the specified collection is null
IllegalArgumentException:: if some property of an element of the specified collection prevents it from being added to this list
IndexOutOfBoundsException:: if the index is out of range (index < 0 || index > size())

get back to summary

get	back to summary
public E get(int index) Implements abstract java.util.AbstractList.get. Implements java.util.List.get. Returns the element at the specified position in this list. This implementation first gets a list iterator pointing to the indexed element (with `listIterator(index)`). Then, it gets the element using `ListIterator.next` and returns it. Parameters index:int Doc from java.util.List.get. index of the element to return Returns:E Doc from java.util.List.get. the element at the specified position in this list Exceptions IndexOutOfBoundsException: if the index is out of range (`index < 0 \|\| index >= size()`)

public E get(int index)

Implements abstract java.util.AbstractList.get.

Implements java.util.List.get.

Returns the element at the specified position in this list.

This implementation first gets a list iterator pointing to the indexed element (with listIterator(index)). Then, it gets the element using ListIterator.next and returns it.

Parameters

index:int

Doc from java.util.List.get.

index of the element to return

Returns:E

Doc from java.util.List.get.

the element at the specified position in this list

Exceptions

IndexOutOfBoundsException:: if the index is out of range (index < 0 || index >= size())

iterator	back to summary
public Iterator<E> iterator() Overrides java.util.AbstractList.iterator. Implements java.util.List.iterator, java.util.Collection.iterator. Returns an iterator over the elements in this list (in proper sequence). This implementation merely returns a list iterator over the list. Returns:Iterator<E> an iterator over the elements in this list (in proper sequence)

iterator

back to summary

public Iterator<E> iterator()

Overrides java.util.AbstractList.iterator.

Implements java.util.List.iterator, java.util.Collection.iterator.

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

This implementation merely returns a list iterator over the list.

Returns:Iterator<E>: an iterator over the elements in this list (in proper sequence)

listIterator back to summary

listIterator	back to summary
public abstract ListIterator<E> listIterator(int index) Redeclares java.util.List.listIterator. Overrides java.util.AbstractList.listIterator. Returns a list iterator over the elements in this list (in proper sequence). Parameters index:int index of first element to be returned from the list iterator (by a call to the `next` method) Returns:ListIterator<E> a list iterator over the elements in this list (in proper sequence) Exceptions IndexOutOfBoundsException: if the index is out of range (`index < 0 \|\| index > size()`)

public abstract ListIterator<E> listIterator(int index)

Redeclares java.util.List.listIterator.

Overrides java.util.AbstractList.listIterator.

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

Parameters

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

Returns:ListIterator<E>

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

Exceptions

IndexOutOfBoundsException:: if the index is out of range (index < 0 || index > size())

remove back to summary

remove	back to summary
public E remove(int index) Overrides java.util.AbstractList.remove. Implements java.util.List.remove. 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. This implementation first gets a list iterator pointing to the indexed element (with `listIterator(index)`). Then, it removes the element with `ListIterator.remove`. Note that this implementation will throw an `UnsupportedOperationException` if the list iterator does not implement the `remove` operation. Parameters index:int Doc from java.util.List.remove. the index of the element to be removed Returns:E Doc from java.util.List.remove. the element previously at the specified position Exceptions UnsupportedOperationException: if the `remove` operation is not supported by this list IndexOutOfBoundsException: if the index is out of range (`index < 0 \|\| index >= size()`)

public E remove(int index)

Overrides java.util.AbstractList.remove.

Implements java.util.List.remove.

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.

This implementation first gets a list iterator pointing to the indexed element (with listIterator(index)). Then, it removes the element with ListIterator.remove.

Note that this implementation will throw an UnsupportedOperationException if the list iterator does not implement the remove operation.

Parameters

index:int

Doc from java.util.List.remove.

the index of the element to be removed

Returns:E

Doc from java.util.List.remove.

the element previously at the specified position

Exceptions

UnsupportedOperationException:: if the remove operation is not supported by this list
IndexOutOfBoundsException:: if the index is out of range (index < 0 || index >= size())

set back to summary

set	back to summary
public E set(int index, E element) Overrides java.util.AbstractList.set. Implements java.util.List.set. Replaces the element at the specified position in this list with the specified element (optional operation). This implementation first gets a list iterator pointing to the indexed element (with `listIterator(index)`). Then, it gets the current element using `ListIterator.next` and replaces it with `ListIterator.set`. Note that this implementation will throw an `UnsupportedOperationException` if the list iterator does not implement the `set` operation. Parameters index:int Doc from java.util.List.set. index of the element to replace element:E Doc from java.util.List.set. element to be stored at the specified position Returns:E Doc from java.util.List.set. the element previously at the specified position Exceptions UnsupportedOperationException: if the `set` 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 the specified element prevents it from being added to this list IndexOutOfBoundsException: if the index is out of range (`index < 0 \|\| index >= size()`)

public E set(int index, E element)

Overrides java.util.AbstractList.set.

Implements java.util.List.set.

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

This implementation first gets a list iterator pointing to the indexed element (with listIterator(index)). Then, it gets the current element using ListIterator.next and replaces it with ListIterator.set.

Note that this implementation will throw an UnsupportedOperationException if the list iterator does not implement the set operation.

Parameters

index:int

Doc from java.util.List.set.

index of the element to replace

element:E

Doc from java.util.List.set.

element to be stored at the specified position

Returns:E

Doc from java.util.List.set.

the element previously at the specified position

Exceptions

UnsupportedOperationException:: if the set 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 the specified element prevents it from being added to this list
IndexOutOfBoundsException:: if the index is out of range (index < 0 || index >= size())

public abstract Class AbstractSequentialList<E>

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail