Skip to content

Most visited

Recently visited

navigation
Added in API level 1

AbstractSequentialList

public abstract class AbstractSequentialList
extends AbstractList<E>

java.lang.Object
   ↳ java.util.AbstractCollection<E>
     ↳ java.util.AbstractList<E>
       ↳ java.util.AbstractSequentialList<E>
Known Direct Subclasses


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.

See also:

Summary

Inherited fields

From class java.util.AbstractList

Protected constructors

AbstractSequentialList()

Sole constructor.

Public methods

void add(int index, E element)

Inserts the specified element at the specified position in 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).

E get(int index)

Returns the element at the specified position in this list.

Iterator<E> iterator()

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

abstract ListIterator<E> listIterator(int index)

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

Inherited methods

From class java.util.AbstractList
From class java.util.AbstractCollection
From class java.lang.Object
From interface java.util.List
From interface java.util.Collection
From interface java.lang.Iterable

Protected constructors

AbstractSequentialList

Added in API level 1
AbstractSequentialList ()

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

Public methods

add

Added in API level 1
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).

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: index at which the specified element is to be inserted
element E: element to be inserted
Throws
UnsupportedOperationException
ClassCastException
NullPointerException
IllegalArgumentException
IndexOutOfBoundsException

addAll

Added in API level 1
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.)

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: index at which to insert the first element from the specified collection
c Collection: collection containing elements to be added to this list
Returns
boolean true if this list changed as a result of the call
Throws
UnsupportedOperationException
ClassCastException
NullPointerException
IllegalArgumentException
IndexOutOfBoundsException

get

Added in API level 1
E get (int index)

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: index of the element to return
Returns
E the element at the specified position in this list
Throws
IndexOutOfBoundsException

iterator

Added in API level 1
Iterator<E> 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

Added in API level 1
ListIterator<E> listIterator (int index)

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)
Throws
IndexOutOfBoundsException

remove

Added in API level 1
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.

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: the index of the element to be removed
Returns
E the element previously at the specified position
Throws
UnsupportedOperationException
IndexOutOfBoundsException

set

Added in API level 1
E set (int index, 
                E element)

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: index of the element to replace
element E: element to be stored at the specified position
Returns
E the element previously at the specified position
Throws
UnsupportedOperationException
ClassCastException
NullPointerException
IllegalArgumentException
IndexOutOfBoundsException
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.