ListIterator (Java 2 Platform SE 5.0) (original) (raw)

java.util

Interface ListIterator

All Superinterfaces:

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. 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 remove() and 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 next() or previous().

This interface is a member of the Java Collections Framework.

Since:

1.2

See Also:

Collection, List, Iterator, Enumeration

Method Summary
void	add(E o) Inserts the specified element into the list (optional operation).
boolean	hasNext() Returns true if this list iterator has more elements when traversing the list in the forward direction.
boolean	hasPrevious() Returns true if this list iterator has more elements when traversing the list in the reverse direction.
E	next() Returns the next element in the list.
int	nextIndex() Returns the index of the element that would be returned by a subsequent call to next.
E	previous() Returns the previous element in the list.
int	previousIndex() Returns the index of the element that would be returned by a subsequent call to previous.
void	remove() Removes from the list the last element that was returned bynext or previous (optional operation).
void	set(E o) Replaces the last element returned by next orprevious with the specified element (optional operation).

Method Detail

hasNext

boolean hasNext()

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

Specified by:

[hasNext](../../java/util/Iterator.html#hasNext%28%29) in interface [Iterator](../../java/util/Iterator.html "interface in java.util")<[E](../../java/util/ListIterator.html "type parameter in ListIterator")>

Returns:

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

E next()

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

Specified by:

[next](../../java/util/Iterator.html#next%28%29) in interface [Iterator](../../java/util/Iterator.html "interface in java.util")<[E](../../java/util/ListIterator.html "type parameter in ListIterator")>

Returns:

the next element in the list.

Throws:

[NoSuchElementException](../../java/util/NoSuchElementException.html "class in java.util") - if the iteration has no next element.

hasPrevious

boolean hasPrevious()

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

Returns:

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

E previous()

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.)

Returns:

the previous element in the list.

Throws:

[NoSuchElementException](../../java/util/NoSuchElementException.html "class in java.util") - if the iteration has no previous element.

nextIndex

int nextIndex()

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.)

Returns:

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.

previousIndex

int previousIndex()

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.)

Returns:

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.

remove

void remove()

Removes from the list the last element that was returned bynext 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.

Specified by:

[remove](../../java/util/Iterator.html#remove%28%29) in interface [Iterator](../../java/util/Iterator.html "interface in java.util")<[E](../../java/util/ListIterator.html "type parameter in ListIterator")>

Throws:

[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang") - if the remove operation is not supported by this list iterator.

[IllegalStateException](../../java/lang/IllegalStateException.html "class in java.lang") - neither next norprevious have been called, or remove oradd have been called after the last call to *next or previous.

set

void set(E o)

Replaces the last element returned by next orprevious with the specified element (optional operation). This call can be made only if neither ListIterator.remove norListIterator.add have been called after the last call tonext or previous.

Parameters:

o - the element with which to replace the last element returned bynext or previous.

Throws:

[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang") - if the set operation is not supported by this list iterator.

[ClassCastException](../../java/lang/ClassCastException.html "class in java.lang") - if the class of the specified element prevents it from being added to this list.

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if some aspect of the specified element prevents it from being added to this list.

[IllegalStateException](../../java/lang/IllegalStateException.html "class in java.lang") - if neither next norprevious have been called, or remove oradd have been called after the last call tonext or previous.

add

void add(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 toprevious would return the new element. (This call increases by one the value that would be returned by a call to nextIndex or previousIndex.)

Parameters:

o - the element to insert.

Throws:

[UnsupportedOperationException](../../java/lang/UnsupportedOperationException.html "class in java.lang") - if the add method is not supported by this list iterator.

[ClassCastException](../../java/lang/ClassCastException.html "class in java.lang") - if the class of the specified element prevents it from being added to this list.

[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if some aspect of this element prevents it from being added to this list.

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.