ListIterator JDK 1.6)

Description

public interface ListIterator

An iterator for lists that allows the programmer to traverse the list in either direction, modify the list during iteration, and obtain the iterator's current position in the list.

An iterator for lists that allows the programmer to traverse the list in either direction, modify the list during iteration, and obtain the iterator's current position in the list. A ListIterator has no current element; its cursor position always lies between the element that would be returned by a call to previous() and the element that would be returned by a call to next(). An iterator for a list of length n has n+1 possible cursor positions, as illustrated by the carets (^) below:

                      Element(0)   Element(1)   Element(2)   ... Element(n-1)
 cursor positions:  ^            ^            ^            ^                  ^

Note that the ListIterator.remove() and ListIterator.set(Object) methods are not defined in terms of the cursor position; they are defined to operate on the last element returned by a call to ListIterator.next() or ListIterator.previous().

This interface is a member of the Java Collections Framework.

See also: Collection List Iterator Enumeration List.listIterator()

Methods

Hide/Show inherited methods

public void add ( E e)

Inserts the specified element into the list (optional operation).

public boolean hasNext () [Specified in Iterator]

Returns true if this list iterator has more elements when traversing the list in the forward direction.

public boolean hasPrevious ()

Returns true if this list iterator has more elements when traversing the list in the reverse direction.

public E next () [Specified in Iterator]

Returns the next element in the list.

public int nextIndex ()

Returns the index of the element that would be returned by a subsequent call to next.

public E previous ()

Returns the previous element in the list.

public int previousIndex ()

Returns the index of the element that would be returned by a subsequent call to previous.

public void remove () [Specified in Iterator]

Removes from the list the last element that was returned by next or previous (optional operation).

public void set ( E e)

Replaces the last element returned by next or previous with the specified element (optional operation).