OpenJDK 27 · java.util.ListIterator · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public void	add(E the element to insert e) Inserts the specified element into the list (optional operation).
public boolean	Returns: `true` if the list iterator has more elements when traversing the list in the forward direction hasNext() Redeclares java.util.Iterator.hasNext. Returns `true` if this list iterator has more elements when traversing the list in the forward direction.
public boolean	Returns: `true` if the list iterator has more elements when traversing the list in the reverse direction hasPrevious() Returns `true` if this list iterator has more elements when traversing the list in the reverse direction.
public E	Returns: the next element in the list next() Redeclares java.util.Iterator.next. Returns the next element in the list and advances the cursor position.
public int	Returns: the index of the element that would be returned by a subsequent call to `next`, or list size if the list iterator is at the end of the list nextIndex() Returns the index of the element that would be returned by a subsequent call to `next`.
public E	Returns: the previous element in the list previous() Returns the previous element in the list and moves the cursor position backwards.
public int	Returns: the index of the element that would be returned by a subsequent call to `previous`, or -1 if the list iterator is at the beginning of the list previousIndex() Returns the index of the element that would be returned by a subsequent call to `previous`.
public void	remove() Redeclares as abstract: java.util.Iterator.remove. Removes from the list the last element that was returned by `next` or `previous` (optional operation).
public void	set(E the element with which to replace the last element returned by `next` or `previous` e) Replaces the last element returned by `next` or `previous` with the specified element (optional operation).

Inherited from java.util.Iterator:: forEachRemaining

Method Detail

add back to summary

add	back to summary
public void add(E e) Inserts the specified element into the list (optional operation). The element is inserted immediately before the element that would be returned by `next`, if any, and after the 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`.) Parameters e:E the element to insert Exceptions UnsupportedOperationException: if the `add` method is not supported by this list iterator ClassCastException: if the class of the specified element prevents it from being added to this list IllegalArgumentException: if some aspect of this element prevents it from being added to this list

public void add(E e)

Inserts the specified element into the list (optional operation). The element is inserted immediately before the element that would be returned by next, if any, and after the 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.)

Parameters

e:E: the element to insert

Exceptions

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

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Redeclares java.util.Iterator.hasNext. 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.) Returns:boolean `true` if the list iterator has more elements when traversing the list in the forward direction

public boolean hasNext()

Redeclares java.util.Iterator.hasNext.

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

Returns:boolean: true if the list iterator has more elements when traversing the list in the forward direction

hasPrevious back to summary

hasPrevious	back to summary
public boolean hasPrevious() 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.) Returns:boolean `true` if the list iterator has more elements when traversing the list in the reverse direction

public boolean hasPrevious()

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

Returns:boolean: true if the list iterator has more elements when traversing the list in the reverse direction

next back to summary

next	back to summary
public E next() Redeclares java.util.Iterator.next. Returns the next element in the list and advances the cursor position. 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:E the next element in the list Exceptions NoSuchElementException: if the iteration has no next element

public E next()

Redeclares java.util.Iterator.next.

Returns the next element in the list and advances the cursor position. 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:E

the next element in the list

Exceptions

NoSuchElementException:: if the iteration has no next element

nextIndex back to summary

nextIndex	back to summary
public 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:int the index of the element that would be returned by a subsequent call to `next`, or list size if the list iterator is at the end of the list

public 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:int: the index of the element that would be returned by a subsequent call to next, or list size if the list iterator is at the end of the list

previous back to summary

previous	back to summary
public E previous() Returns the previous element in the list and moves the cursor position backwards. 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:E the previous element in the list Exceptions NoSuchElementException: if the iteration has no previous element

public E previous()

Returns the previous element in the list and moves the cursor position backwards. 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:E

the previous element in the list

Exceptions

NoSuchElementException:: if the iteration has no previous element

previousIndex back to summary

previousIndex	back to summary
public 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:int the index of the element that would be returned by a subsequent call to `previous`, or -1 if the list iterator is at the beginning of the list

public 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:int: the index of the element that would be returned by a subsequent call to previous, or -1 if the list iterator is at the beginning of the list

remove back to summary

remove	back to summary
public void remove() Redeclares as abstract: java.util.Iterator.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 `add` has not been called after the last call to `next` or `previous`. Exceptions UnsupportedOperationException: if the `remove` operation is not supported by this list iterator IllegalStateException: if neither `next` nor `previous` have been called, or `remove` or `add` have been called after the last call to `next` or `previous`

public void remove()

Redeclares as abstract: java.util.Iterator.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 add has not been called after the last call to next or previous.

Exceptions

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

set back to summary

set	back to summary
public void set(E e) Replaces the last element returned by `next` or `previous` with the specified element (optional operation). This call can be made only if neither `remove` nor `add` have been called after the last call to `next` or `previous`. Parameters e:E the element with which to replace the last element returned by `next` or `previous` Exceptions UnsupportedOperationException: if the `set` operation is not supported by this list iterator ClassCastException: if the class of the specified element prevents it from being added to this list IllegalArgumentException: if some aspect of the specified element prevents it from being added to this list IllegalStateException: if neither `next` nor `previous` have been called, or `remove` or `add` have been called after the last call to `next` or `previous`

public void set(E e)

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

Parameters

e:E: the element with which to replace the last element returned by next or previous

Exceptions

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

public Interface ListIterator<E>

Method Summary

Method Detail