to top
Android APIs
public interface

ListIterator

implements Iterator<E>
java.util.ListIterator<E>

Class Overview

An ListIterator is used to sequence over a List of objects. ListIterator can move backwards or forwards through the list.

Summary

Public Methods
abstract void add(E object)
Inserts the specified object into the list between next and previous.
abstract boolean hasNext()
Returns whether there are more elements to iterate.
abstract boolean hasPrevious()
Returns whether there are previous elements to iterate.
abstract E next()
Returns the next object in the iteration.
abstract int nextIndex()
Returns the index of the next object in the iteration.
abstract E previous()
Returns the previous object in the iteration.
abstract int previousIndex()
Returns the index of the previous object in the iteration.
abstract void remove()
Removes the last object returned by next or previous from the list.
abstract void set(E object)
Replaces the last object returned by next or previous with the specified object.
[Expand]
Inherited Methods
From interface java.util.Iterator

Public Methods

public abstract void add (E object)

Added in API level 1

Inserts the specified object into the list between next and previous. The object inserted will be the previous object.

Parameters
object the object to insert.
Throws
UnsupportedOperationException if adding is not supported by the list being iterated.
ClassCastException if the class of the object is inappropriate for the list.
IllegalArgumentException if the object cannot be added to the list.

public abstract boolean hasNext ()

Added in API level 1

Returns whether there are more elements to iterate.

Returns
  • true if there are more elements, false otherwise.
See Also

public abstract boolean hasPrevious ()

Added in API level 1

Returns whether there are previous elements to iterate.

Returns
  • true if there are previous elements, false otherwise.
See Also

public abstract E next ()

Added in API level 1

Returns the next object in the iteration.

Returns
  • the next object.
Throws
NoSuchElementException if there are no more elements.
See Also

public abstract int nextIndex ()

Added in API level 1

Returns the index of the next object in the iteration.

Returns
  • the index of the next object, or the size of the list if the iterator is at the end.
Throws
NoSuchElementException if there are no more elements.
See Also

public abstract E previous ()

Added in API level 1

Returns the previous object in the iteration.

Returns
  • the previous object.
Throws
NoSuchElementException if there are no previous elements.
See Also

public abstract int previousIndex ()

Added in API level 1

Returns the index of the previous object in the iteration.

Returns
  • the index of the previous object, or -1 if the iterator is at the beginning.
Throws
NoSuchElementException if there are no previous elements.
See Also

public abstract void remove ()

Added in API level 1

Removes the last object returned by next or previous from the list.

Throws
UnsupportedOperationException if removing is not supported by the list being iterated.
IllegalStateException if next or previous have not been called, or remove or add have already been called after the last call to next or previous.

public abstract void set (E object)

Added in API level 1

Replaces the last object returned by next or previous with the specified object.

Parameters
object the object to set.
Throws
UnsupportedOperationException if setting is not supported by the list being iterated
ClassCastException if the class of the object is inappropriate for the list.
IllegalArgumentException if the object cannot be added to the list.
IllegalStateException if next or previous have not been called, or remove or add have already been called after the last call to next or previous.
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.