java.util.ListIterator< E > Interface Template Reference

Inheritance diagram for java.util.ListIterator< E >:

Public Member Functions
void	add (E object)
boolean	hasNext ()
boolean	hasPrevious ()
E	next ()
int	nextIndex ()
E	previous ()
int	previousIndex ()
void	remove ()
void	set (E object)

Detailed Description

An ListIterator is used to sequence over a List of objects. ListIterator can move backwards or forwards through the list.

Member Function Documentation

add()

void java.util.ListIterator< E >.add

(

E

object

)

Inserts the specified object into the list between

next 

and

previous 

. The object inserted will be the previous object.

Parameters

object

the object to insert.

Exceptions

UnsupportedOperationException	if adding is not supported by the list being iterated.
ClassCastException	if the class of the object is inappropriate for the list.
IllegalArgumentException	if the object cannot be added to the list.

hasNext()

boolean java.util.ListIterator< E >.hasNext

(

)

Returns whether there are more elements to iterate.

Returns

true 

if there are more elements,

false 

otherwise.

See also

next

Implements java.util.Iterator< E >.

hasPrevious()

boolean java.util.ListIterator< E >.hasPrevious

(

)

Returns whether there are previous elements to iterate.

Returns

true 

if there are previous elements,

false 

otherwise.

See also

previous

next()

E java.util.ListIterator< E >.next

(

)

Returns the next object in the iteration.

Returns

the next object.

Exceptions

NoSuchElementException

if there are no more elements.

See also

hasNext

Implements java.util.Iterator< E >.

nextIndex()

int java.util.ListIterator< E >.nextIndex

(

)

Returns the index of the next object in the iteration.

Returns

the index of the next object, or the size of the list if the iterator is at the end.

Exceptions

NoSuchElementException

if there are no more elements.

See also

next

previous()

E java.util.ListIterator< E >.previous

(

)

Returns the previous object in the iteration.

Returns

the previous object.

Exceptions

NoSuchElementException

if there are no previous elements.

See also

hasPrevious

previousIndex()

int java.util.ListIterator< E >.previousIndex

(

)

Returns the index of the previous object in the iteration.

Returns

the index of the previous object, or -1 if the iterator is at the beginning.

Exceptions

NoSuchElementException

if there are no previous elements.

See also

previous

remove()

void java.util.ListIterator< E >.remove

(

)

Removes the last object returned by

next 

or

previous 

from the list.

Exceptions

UnsupportedOperationException	if removing is not supported by the list being iterated.
IllegalStateException	if next or previous have not been called, or remove or add have already been called after the last call to next or previous .

Implements java.util.Iterator< E >.

set()

void java.util.ListIterator< E >.set

(

E

object

)

Replaces the last object returned by

next 

or

previous 

with the specified object.

Parameters

object

the object to set.

Exceptions

UnsupportedOperationException	if setting is not supported by the list being iterated
ClassCastException	if the class of the object is inappropriate for the list.
IllegalArgumentException	if the object cannot be added to the list.
IllegalStateException	if next or previous have not been called, or remove or add have already been called after the last call to next or previous .

---

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

• src/java/util/ListIterator.java