Added in API level 1

AbstractSequentialList

abstract class AbstractSequentialList<E : Any!> : AbstractList<E>
kotlin.Any
   ↳ java.util.AbstractCollection<E>
   ↳ java.util.AbstractList<E>
   ↳ java.util.AbstractSequentialList

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.

Summary

Protected constructors

Sole constructor.

Public methods
open Unit
add(index: Int, element: E)

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

open Boolean
addAll(index: Int, elements: Collection<E>)

Inserts all of the elements in the specified collection into this list at the specified position (optional operation).

open E
get(index: Int)

Returns the element at the specified position in this list.

open MutableIterator<E>

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

abstract MutableListIterator<E>
listIterator(index: Int)

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

open E
removeAt(index: Int)

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

open E
set(index: Int, element: E)

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

Inherited functions
Inherited properties

Protected constructors

AbstractSequentialList

Added in API level 1
protected AbstractSequentialList()

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

Public methods

add

Added in API level 1
open fun add(
    index: Int,
    element: E
): Unit

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
Exceptions
java.lang.UnsupportedOperationException if the add operation is not supported by this list
java.lang.ClassCastException if the class of the specified element prevents it from being added to this list
java.lang.NullPointerException if the specified element is null and this list does not permit null elements
java.lang.IllegalArgumentException if some property of the specified element prevents it from being added to this list
java.lang.IndexOutOfBoundsException if the index is out of range (index < 0 || index > size())

addAll

Added in API level 1
open fun addAll(
    index: Int,
    elements: Collection<E>
): Boolean

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 containing elements to be added to this list
Return
Boolean true if this list changed as a result of the call
Exceptions
java.lang.UnsupportedOperationException if the addAll operation is not supported by this list
java.lang.ClassCastException if the class of an element of the specified collection prevents it from being added to this list
java.lang.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
java.lang.IllegalArgumentException if some property of an element of the specified collection prevents it from being added to this list
java.lang.IndexOutOfBoundsException if the index is out of range (index < 0 || index > size())

get

Added in API level 1
open fun get(index: Int): E

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
Return
E the element at the specified position in this list
Exceptions
java.lang.IndexOutOfBoundsException if the index is out of range (index < 0 || index >= size())

iterator

Added in API level 1
open fun iterator(): MutableIterator<E>

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

This implementation merely returns a list iterator over the list.

Return
MutableIterator<E> an iterator over the elements in this list (in proper sequence)

listIterator

Added in API level 1
abstract fun listIterator(index: Int): MutableListIterator<E>

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)
Return
MutableListIterator<E> a list iterator over the elements in this list (in proper sequence)
Exceptions
java.lang.IndexOutOfBoundsException if the index is out of range (index < 0 || index > size())

removeAt

Added in API level 1
open fun removeAt(index: Int): E

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
Return
E the element previously at the specified position
Exceptions
java.lang.UnsupportedOperationException if the remove operation is not supported by this list
java.lang.IndexOutOfBoundsException if the index is out of range (index < 0 || index >= size())

set

Added in API level 1
open fun set(
    index: Int,
    element: E
): E

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
Return
E the element previously at the specified position
Exceptions
java.lang.UnsupportedOperationException if the set operation is not supported by this list
java.lang.ClassCastException if the class of the specified element prevents it from being added to this list
java.lang.NullPointerException if the specified element is null and this list does not permit null elements
java.lang.IllegalArgumentException if some property of the specified element prevents it from being added to this list
java.lang.IndexOutOfBoundsException if the index is out of range (index < 0 || index >= size())