All Packages Class Hierarchy This Package Previous Next Index
Interface com.sun.java.util.collections.ListIterator
- public interface ListIterator
- extends Iterator
An Iterator for Lists that allows the programmer to traverse the
List in either direction and modify the List during iteration.
- See Also:
- Collection, List, Iterator, Enumeration
-
add(Object)
- Inserts the specified element into the List (optional operation).
-
hasNext()
- Returns true if this ListIterator has more elements when
traversing the List in the forward direction.
-
hasPrevious()
- Returns true if this ListIterator has more elements when
traversing the List in the reverse direction.
-
next()
- Returns the next element in the List.
-
nextIndex()
- Returns the index of the element that would be returned by a subsequent
call to next.
-
previous()
- Returns the previous element in the List.
-
previousIndex()
- Returns the index of the element that would be returned by a subsequent
call to previous.
-
remove()
- Removes from the List the last element that was returned by
next or previous (optional operation).
-
set(Object)
- Replaces the last element returned by next or
previous with the specified element (optional operation).
hasNext
public abstract boolean hasNext()
- Returns true if this ListIterator 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.)
- Returns:
- true if the ListIterator has more elements when
traversing the List in the forward direction.
next
public abstract Object next()
- 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.)
- Returns:
- the next element in the List.
- Throws: NoSuchElementException
- iteration has no next element.
hasPrevious
public abstract boolean hasPrevious()
- Returns true if this ListIterator 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.)
- Returns:
- true if the ListIterator has more elements when
traversing the List in the reverse direction.
previous
public abstract Object 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
- iteration has no previous element.
nextIndex
public abstract int nextIndex()
- Returns the index of the element that would be returned by a subsequent
call to next. (Returns List size if the ListIterator 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 ListIterator is at end
of List.
previousIndex
public abstract int previousIndex()
- Returns the index of the element that would be returned by a subsequent
call to previous. (Returns -1 if the ListIterator 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 ListIterator is at
beginning of List.
remove
public abstract void remove()
- 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.
- Throws: UnsupportedOperationException
- remove is not
supported by this ListIterator.
- Throws: IllegalStateException
- neither next nor
previous have been called, or remove or
add have been called after the last call to
next or previous.
set
public abstract void set(Object 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.
- Throws: UnsupportedOperationException
- set is not supported
by this ListIterator.
- Throws: ClassCastException
- class of the specified element
prevents it from being added to this List.
- Throws: IllegalArgumentException
- some aspect of the specified
element prevents it from being added to this List.
- Throws: IllegalStateException
- neither next nor
previous have been called, or remove or
add have been called after the last call to
next or previous.
add
public abstract void add(Object 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.)
- Throws: UnsupportedOperationException
- add is not supported
by this ListIterator.
- Throws: ClassCastException
- class of the specified element
prevents it from being added to this Set.
- Throws: IllegalArgumentException
- some aspect of this element prevents
it from being added to this Collection.
All Packages Class Hierarchy This Package Previous Next Index