Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public abstract class

AbstractList

extends AbstractCollection <E>
implements List <E>
java.lang.Object
   ↳ java.util.AbstractCollection <E>
     ↳ java.util.AbstractList<E>
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

AbstractList is an abstract implementation of the List interface, optimized for a backing store which supports random access. This implementation does not support adding or replacing. A subclass must implement the abstract methods get() and size() , and to create a modifiable List it's necessary to override the add() method that currently throws an UnsupportedOperationException .

Summary

Fields
protected int modCount A counter for changes to the list.
Protected Constructors
AbstractList ()
Constructs a new instance of this AbstractList.
Public Methods
boolean add (E object)
Adds the specified object at the end of this List.
void add (int location, E object)
Inserts the specified object into this List at the specified location.
boolean )">addAll (int location, Collection <? extends E> collection)
Inserts the objects in the specified Collection at the specified location in this List.
void clear ()
Removes all elements from this list, leaving it empty.
boolean equals ( Object object)
Compares the specified object to this list and return true if they are equal.
abstract E get (int location)
Returns the element at the specified location in this list.
int hashCode ()
Returns the hash code of this list.
int indexOf ( Object object)
Searches this list for the specified object and returns the index of the first occurrence.
Iterator <E> iterator ()
Returns an iterator on the elements of this list.
int lastIndexOf ( Object object)
Searches this list for the specified object and returns the index of the last occurrence.
ListIterator <E> listIterator (int location)
Returns a list iterator on the elements of this list.
ListIterator <E> listIterator ()
Returns a ListIterator on the elements of this list.
E remove (int location)
Removes the object at the specified location from this list.
E set (int location, E object)
Replaces the element at the specified location in this list with the specified object.
List <E> subList (int start, int end)
Returns a part of consecutive elements of this list as a view.
Protected Methods
void removeRange (int start, int end)
Removes the objects in the specified range from the start to the end index minus one.
[Expand]
Inherited Methods
From class java.util.AbstractCollection
From class java.lang.Object
From interface java.lang.Iterable
From interface java.util.Collection
From interface java.util.List

Fields

protected int modCount

Added in API level 1

A counter for changes to the list.

Protected Constructors

protected AbstractList ()

Added in API level 1

Constructs a new instance of this AbstractList.

Public Methods

public boolean add (E object)

Added in API level 1

Adds the specified object at the end of this List.

Parameters
object the object to add
Returns
  • true
Throws
UnsupportedOperationException if adding to this List is not supported
ClassCastException if the class of the object is inappropriate for this List
IllegalArgumentException if the object cannot be added to this List

public void add (int location, E object)

Added in API level 1

Inserts the specified object into this List at the specified location. The object is inserted before any previous element at the specified location. If the location is equal to the size of this List, the object is added at the end.

Concrete implementations that would like to support the add functionality must override this method.

Parameters
location the index at which to insert.
object the object to add.
Throws
UnsupportedOperationException if adding to this List is not supported.
ClassCastException if the class of the object is inappropriate for this List
IllegalArgumentException if the object cannot be added to this List
IndexOutOfBoundsException if location < 0 || location > size()
)">

public boolean addAll (int location, Collection <? extends E> collection)

Added in API level 1

Inserts the objects in the specified Collection at the specified location in this List. The objects are added in the order they are returned from the collection's iterator.

Parameters
location the index at which to insert.
collection the Collection of objects
Returns
  • true if this List is modified, false otherwise.
Throws
UnsupportedOperationException if adding to this list is not supported.
ClassCastException if the class of an object is inappropriate for this list.
IllegalArgumentException if an object cannot be added to this list.
IndexOutOfBoundsException if location < 0 || location > size()

public void clear ()

Added in API level 1

Removes all elements from this list, leaving it empty.

Throws
UnsupportedOperationException if removing from this list is not supported.
See Also

public boolean equals ( Object object)

Added in API level 1

Compares the specified object to this list and return true if they are equal. Two lists are equal when they both contain the same objects in the same order.

Parameters
object the object to compare to this object.
Returns
  • true if the specified object is equal to this list, false otherwise.
See Also

public abstract E get (int location)

Added in API level 1

Returns the element at the specified location in this list.

Parameters
location the index of the element to return.
Returns
  • the element at the specified index.
Throws
IndexOutOfBoundsException if location < 0 || location >= size()

public int hashCode ()

Added in API level 1

Returns the hash code of this list. The hash code is calculated by taking each element's hashcode into account.

Returns
  • the hash code.
See Also

public int indexOf ( Object object)

Added in API level 1

Searches this list for the specified object and returns the index of the first occurrence.

Parameters
object the object to search for.
Returns
  • the index of the first occurrence of the object, or -1 if it was not found.

public Iterator <E> iterator ()

Added in API level 1

Returns an iterator on the elements of this list. The elements are iterated in the same order as they occur in the list.

Returns
  • an iterator on the elements of this list.
See Also

public int lastIndexOf ( Object object)

Added in API level 1

Searches this list for the specified object and returns the index of the last occurrence.

Parameters
object the object to search for.
Returns
  • the index of the last occurrence of the object, or -1 if the object was not found.

public ListIterator <E> listIterator (int location)

Added in API level 1

Returns a list iterator on the elements of this list. The elements are iterated in the same order as they occur in the list. The iteration starts at the specified location.

Parameters
location the index at which to start the iteration.
Returns
  • a ListIterator on the elements of this list.
Throws
IndexOutOfBoundsException if location < 0 || location > size()
See Also

public ListIterator <E> listIterator ()

Added in API level 1

Returns a ListIterator on the elements of this list. The elements are iterated in the same order that they occur in the list.

Returns
  • a ListIterator on the elements of this list
See Also

public E remove (int location)

Added in API level 1

Removes the object at the specified location from this list.

Parameters
location the index of the object to remove.
Returns
  • the removed object.
Throws
UnsupportedOperationException if removing from this list is not supported.
IndexOutOfBoundsException if location < 0 || location >= size()

public E set (int location, E object)

Added in API level 1

Replaces the element at the specified location in this list with the specified object.

Parameters
location the index at which to put the specified object.
object the object to add.
Returns
  • the previous element at the index.
Throws
UnsupportedOperationException if replacing elements in this list is not supported.
ClassCastException if the class of an object is inappropriate for this list.
IllegalArgumentException if an object cannot be added to this list.
IndexOutOfBoundsException if location < 0 || location >= size()

public List <E> subList (int start, int end)

Added in API level 1

Returns a part of consecutive elements of this list as a view. The returned view will be of zero length if start equals end. Any change that occurs in the returned subList will be reflected to the original list, and vice-versa. All the supported optional operations by the original list will also be supported by this subList.

This method can be used as a handy method to do some operations on a sub range of the original list, for example list.subList(from, to).clear();

If the original list is modified in other ways than through the returned subList, the behavior of the returned subList becomes undefined.

The returned subList is a subclass of AbstractList. The subclass stores offset, size of itself, and modCount of the original list. If the original list implements RandomAccess interface, the returned subList also implements RandomAccess interface.

The subList's set(int, Object), get(int), add(int, Object), remove(int), addAll(int, Collection) and removeRange(int, int) methods first check the bounds, adjust offsets and then call the corresponding methods of the original AbstractList. addAll(Collection c) method of the returned subList calls the original addAll(offset + size, c).

The listIterator(int) method of the subList wraps the original list iterator. The iterator() method of the subList invokes the original listIterator() method, and the size() method merely returns the size of the subList.

All methods will throw a ConcurrentModificationException if the modCount of the original list is not equal to the expected value.

Parameters
start start index of the subList (inclusive).
end end index of the subList, (exclusive).
Returns
  • a subList view of this list starting from start (inclusive), and ending with end (exclusive)
Throws
IndexOutOfBoundsException if (start < 0 || end > size())
IllegalArgumentException if (start > end)

Protected Methods

protected void removeRange (int start, int end)

Added in API level 1

Removes the objects in the specified range from the start to the end index minus one.

Parameters
start the index at which to start removing.
end the index after the last element to remove.
Throws
UnsupportedOperationException if removing from this list is not supported.
IndexOutOfBoundsException if start < 0 or start >= size() .