Интерфейс ListIterator<E>

public interface ListIterator<E>
extends Iterator<E>

Итератор для списков, позволяющий программисту перемещаться по списку в обоих направлениях, изменять список во время итерации и получить текущую позицию итератора в списке. У итератора ListIterator нет текущего элемента; его позиция курсора всегда находится между элементом, который был бы возвращён вызовом previous() и элементом, который был бы возвращён вызовом next(). У итератора для списка длиной n существует n+1 возможных позиций курсора, как показано на каретах (^) ниже:

Element(0)   Element(1)   Element(2)   ... Element(n-1)
 cursor positions:  ^            ^            ^            ^                  ^

Обратите внимание, что методы remove() и set(Object) не определены в терминах позиции курсора; они определены для работы с последним элементом, возвращённым вызовом next() или previous().

Этот интерфейс является членом Java Collections Framework.

Методы

hasNext

boolean hasNext()

Возвращает true если этот итератор списка имеет больше элементов при прохождении списка в прямом направлении. (Другими словами, возвращает true если next() вернёт элемент, а не выбросит исключение.)

Определено в:

hasNext в интерфейсе Iterator<E>

Возвращает:

true если итератор списка имеет больше элементов при прохождении списка в прямом направлении

next

E next()

Возвращает следующий элемент в списке и перемещает позицию курсора. Этот метод может быть вызван многократно для итерации по списку или совместно с вызовами previous() для перемещения вперёд и назад. (Обратите внимание, что чередование вызовов next и previous будет возвращать один и тот же элемент многократно.)

Определено в:

next в интерфейсе Iterator<E>

Возвращает:

следующий элемент в списке

Выбрасывает:

NoSuchElementException - если у итерации нет следующего элемента

hasPrevious

boolean hasPrevious()

Возвращает true если этот итератор списка имеет больше элементов при прохождении списка в обратном направлении. (Другими словами, возвращает true если previous() вернёт элемент, а не выбросит исключение.)

Возвращает:

true если итератор списка имеет больше элементов при прохождении списка в обратном направлении

previous

E previous()

Возвращает предыдущий элемент в списке и перемещает позицию курсора назад. Этот метод может быть вызван многократно для итерации по списку назад или совместно с вызовами next() для перемещения вперёд и назад. (Обратите внимание, что чередование вызовов next и previous будет возвращать один и тот же элемент многократно.)

Возвращает:

предыдущий элемент в списке

Выбрасывает:

NoSuchElementException - если у итерации нет предыдущего элемента

nextIndex

int nextIndex()

Возвращает индекс элемента, который будет возвращён последующим вызовом next(). (Возвращает размер списка, если итератор списка находится в конце списка.)

Возвращает:

индекс элемента, который будет возвращён последующим вызовом next, или размер списка, если итератор списка находится в конце списка

previousIndex

int previousIndex()

Возвращает индекс элемента, который будет возвращён последующим вызовом previous(). (Возвращает -1, если итератор списка находится в начале списка.)

Возвращает:

индекс элемента, который будет возвращён последующим вызовом previous, или -1, если итератор списка находится в начале списка

remove

void remove()

Удаляет из списка последний элемент, который был возвращён вызовом next() или previous() (необязательная операция). Этот вызов может быть выполнен только один раз за вызов next или previous. Он может быть выполнен только в том случае, если add(E) не был вызван после последнего вызова next или previous.

Определено в:

remove в интерфейсе Iterator<E>

Выбрасывает:

UnsupportedOperationException - если операция remove не поддерживается этим итератором списка

IllegalStateException - если ни next ни previous не были вызваны, или remove или add были вызваны после последнего вызова next или previous

set

void set(E e)

Заменяет последний элемент, возвращённый вызовом next() или previous(), указанным элементом (необязательная операция). Этот вызов может быть выполнен только в том случае, если ни remove() ни add(E) не были вызваны после последнего вызова next или previous.

Параметры:

e - элемент, которым нужно заменить последний элемент, возвращённый вызовом next или previous

Выбрасывает:

UnsupportedOperationException - если операция set не поддерживается этим итератором списка

ClassCastException - если класс указанного элемента не позволяет добавить его в этот список

IllegalArgumentException - если какой-либо аспект указанного элемента не позволяет добавить его в этот список

IllegalStateException - если ни next ни previous не были вызваны, или remove или add были вызваны после последнего вызова next или previous

add

void add(E e)

Вставляет указанный элемент в список (необязательная операция). Элемент вставляется непосредственно перед элементом, который будет возвращён вызовом next(), если таковой имеется, и после элемента, который будет возвращён вызовом previous(), если таковой имеется. (Если список не содержит элементов, новый элемент становится единственным элементом в списке.) Новый элемент вставляется перед неявным курсором: последующий вызов next не повлияет на него, а последующий вызов previous вернёт новый элемент. (Этот вызов увеличивает на единицу значение, которое было бы возвращено вызовом nextIndex или previousIndex)

Параметры:

e - вставляемый элемент

Выбрасывает:

UnsupportedOperationException - если метод add не поддерживается этим итератором списка

ClassCastException - если класс указанного элемента не позволяет добавить его в этот список

IllegalArgumentException - если какой-либо аспект этого элемента не позволяет добавить его в этот список