FileDocCategorySizeDatePackage
ListIterator.javaAPI DocJava SE 5 API7513Fri Aug 26 14:57:24 BST 2005java.util

ListIterator

public interface ListIterator implements Iterator
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(). In a list of length n, there are n+1 valid index values, from 0 to n, inclusive.

Element(0) Element(1) Element(2) ... Element(n)
^ ^ ^ ^ ^
Index: 0 1 2 3 n+1

Note that the {@link #remove} and {@link #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 {@link #next} or {@link #previous()}.

This interface is a member of the Java Collections Framework.

author
Josh Bloch
version
1.23, 12/19/03
see
Collection
see
List
see
Iterator
see
Enumeration
since
1.2

Fields Summary
Constructors Summary
Methods Summary
public voidadd(E o)
Inserts the specified element into the list (optional operation). The element is inserted immediately before the next element that would be returned by next, if any, and after the next element that would be returned by previous, if any. (If the list contains no elements, the new element becomes the sole element on the list.) The new element is inserted before the implicit cursor: a subsequent call to next would be unaffected, and a subsequent call to previous would return the new element. (This call increases by one the value that would be returned by a call to nextIndex or previousIndex.)

param
o the element to insert.
exception
UnsupportedOperationException if the add method is not supported by this list iterator.
exception
ClassCastException if the class of the specified element prevents it from being added to this list.
exception
IllegalArgumentException if some aspect of this element prevents it from being added to this list.

public booleanhasNext()
Returns true if this list iterator has more elements when traversing the list in the forward direction. (In other words, returns true if next would return an element rather than throwing an exception.)

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

public booleanhasPrevious()
Returns true if this list iterator has more elements when traversing the list in the reverse direction. (In other words, returns true if previous would return an element rather than throwing an exception.)

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

public Enext()
Returns the next element in the list. This method may be called repeatedly to iterate through the list, or intermixed with calls to previous to go back and forth. (Note that alternating calls to next and previous will return the same element repeatedly.)

return
the next element in the list.
exception
NoSuchElementException if the iteration has no next element.

public intnextIndex()
Returns the index of the element that would be returned by a subsequent call to next. (Returns list size if the list iterator is at the end of the list.)

return
the index of the element that would be returned by a subsequent call to next, or list size if list iterator is at end of list.

public Eprevious()
Returns the previous element in the list. This method may be called repeatedly to iterate through the list backwards, or intermixed with calls to next to go back and forth. (Note that alternating calls to next and previous will return the same element repeatedly.)

return
the previous element in the list.
exception
NoSuchElementException if the iteration has no previous element.

public intpreviousIndex()
Returns the index of the element that would be returned by a subsequent call to previous. (Returns -1 if the list iterator is at the beginning of the list.)

return
the index of the element that would be returned by a subsequent call to previous, or -1 if list iterator is at beginning of list.

public voidremove()
Removes from the list the last element that was returned by next or previous (optional operation). This call can only be made once per call to next or previous. It can be made only if ListIterator.add has not been called after the last call to next or previous.

exception
UnsupportedOperationException if the remove operation is not supported by this list iterator.
exception
IllegalStateException neither next nor previous have been called, or remove or add have been called after the last call to * next or previous.

public voidset(E o)
Replaces the last element returned by next or previous with the specified element (optional operation). This call can be made only if neither ListIterator.remove nor ListIterator.add have been called after the last call to next or previous.

param
o the element with which to replace the last element returned by next or previous.
exception
UnsupportedOperationException if the set operation is not supported by this list iterator.
exception
ClassCastException if the class of the specified element prevents it from being added to this list.
exception
IllegalArgumentException if some aspect of the specified element prevents it from being added to this list.
exception
IllegalStateException if neither next nor previous have been called, or remove or add have been called after the last call to next or previous.