Back to index

plt-scheme  4.2.1
Public Member Functions
java.util.ListIterator Interface Reference

An extended version of Iterator to support the extra features of Lists. More...

Inheritance diagram for java.util.ListIterator:
Inheritance graph
[legend]
Collaboration diagram for java.util.ListIterator:
Collaboration graph
[legend]

List of all members.

Public Member Functions

boolean hasNext ()
 Tests whether there are elements remaining in the list in the forward direction.
boolean hasPrevious ()
 Tests whether there are elements remaining in the list in the reverse direction.
Object next ()
 Obtain the next element in the list in the forward direction.
Object previous ()
 Obtain the next element in the list in the reverse direction.
int nextIndex ()
 Find the index of the element that would be returned by a call to next.
int previousIndex ()
 Find the index of the element that would be returned by a call to previous.
void add (Object o)
 Insert an element into the list at the current position of the iterator (optional operation).
void remove ()
 Remove from the list the element last returned by a call to next or previous (optional operation).
void set (Object o)
 Replace the element last returned by a call to next or previous with a given object (optional operation).

Detailed Description

An extended version of Iterator to support the extra features of Lists.

The elements may be accessed in forward or reverse order, elements may be replaced as well as removed, and new elements may be inserted, during the traversal of the list.

A list with n elements provides n+1 iterator positions (the front, the end, or between two elements). Note that remove and set operate on the last element returned, whether it was by next or previous.

Author:
Original author unknown
Eric Blake ebb9@.nosp@m.emai.nosp@m.l.byu.nosp@m..edu
See also:
Collection
List
Iterator
Enumeration
Since:
1.2 updated to 1.4

Definition at line 62 of file ListIterator.java.


Member Function Documentation

Insert an element into the list at the current position of the iterator (optional operation).

The element is inserted in between the element that would be returned by previous and the element that would be returned by next. After the insertion, a subsequent call to next is unaffected, but a call to previous returns the item that was added. The values returned by nextIndex() and previousIndex() are incremented.

Parameters:
othe object to insert into the list
Exceptions:
ClassCastExceptionthe object is of a type which cannot be added to this list
IllegalArgumentExceptionsome other aspect of the object stops it being added to this list
UnsupportedOperationExceptionif this ListIterator does not support the add operation

Implemented in java.util.SubList.SLListIterator, and java.util.AbstractList.lIListIterator.

Here is the caller graph for this function:

Tests whether there are elements remaining in the list in the forward direction.

In other words, next() will not fail with a NoSuchElementException.

Returns:
true if the list continues in the forward direction

Implements java.util.Iterator.

Implemented in java.util.SubList.SLListIterator, and java.util.AbstractList.lIListIterator.

Tests whether there are elements remaining in the list in the reverse direction.

In other words, previous() will not fail with a NoSuchElementException.

Returns:
true if the list continues in the reverse direction

Implemented in java.util.SubList.SLListIterator, and java.util.AbstractList.lIListIterator.

Obtain the next element in the list in the forward direction.

Repeated calls to next may be used to iterate over the entire list, or calls to next and previous may be used together to go forwards and backwards. Alternating calls to next and previous will return the same element.

Returns:
the next element in the list in the forward direction
Exceptions:
NoSuchElementExceptionif there are no more elements

Implements java.util.Iterator.

Implemented in java.util.SubList.SLListIterator, and java.util.AbstractList.lIListIterator.

Here is the caller graph for this function:

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

If hasNext() returns false, this returns the list size.

Returns:
the index of the element that would be returned by next()

Implemented in java.util.SubList.SLListIterator, and java.util.AbstractList.lIListIterator.

Here is the caller graph for this function:

Obtain the next element in the list in the reverse direction.

Repeated calls to previous may be used to iterate backwards over the entire list, or calls to next and previous may be used together to go forwards and backwards. Alternating calls to next and previous will return the same element.

Returns:
the next element in the list in the reverse direction
Exceptions:
NoSuchElementExceptionif there are no more elements

Implemented in java.util.SubList.SLListIterator, and java.util.AbstractList.lIListIterator.

Here is the caller graph for this function:

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

If hasPrevious() returns false, this returns -1.

Returns:
the index of the element that would be returned by previous()

Implemented in java.util.SubList.SLListIterator, and java.util.AbstractList.lIListIterator.

Here is the caller graph for this function:

Remove from the list the element last returned by a call to next or previous (optional operation).

This method may only be called if neither add nor remove have been called since the last call to next or previous.

Exceptions:
IllegalStateExceptionif neither next or previous have been called, or if add or remove has been called since the last call to next or previous
UnsupportedOperationExceptionif this ListIterator does not support the remove operation

Implements java.util.Iterator.

Implemented in java.util.SubList.SLListIterator, and java.util.AbstractList.lIListIterator.

Here is the caller graph for this function:

Replace the element last returned by a call to next or previous with a given object (optional operation).

This method may only be called if neither add nor remove have been called since the last call to next or previous.

Parameters:
othe object to replace the element with
Exceptions:
ClassCastExceptionthe object is of a type which cannot be added to this list
IllegalArgumentExceptionsome other aspect of the object stops it being added to this list
IllegalStateExceptionif neither next or previous have been called, or if add or remove has been called since the last call to next or previous
UnsupportedOperationExceptionif this ListIterator does not support the set operation

Implemented in java.util.SubList.SLListIterator, and java.util.AbstractList.lIListIterator.

Here is the caller graph for this function:


The documentation for this interface was generated from the following file: