Интерфейс ListIterator<E>
- Все суперинтерфейсы:
Iterator<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.
- С тех пор:
- 1.2
- См. также:
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
void |
add |
Вставляет указанный элемент в список (необязательная операция). |
boolean |
hasNext() |
Возвращает true, если этот итератор списка имеет больше элементов при проходе по списку в прямом направлении. |
boolean |
hasPrevious() |
Возвращает true, если этот итератор списка имеет больше элементов при проходе по списку в обратном направлении. |
E |
next() |
Возвращает следующий элемент в списке и продвигает позицию курсора. |
int |
nextIndex() |
Возвращает индекс элемента, который будет возвращён последующим вызовом next(). |
E |
previous() |
Возвращает предыдущий элемент в списке и перемещает позицию курсора назад. |
int |
previousIndex() |
Возвращает индекс элемента, который будет возвращён последующим вызовом previous(). |
void |
remove() |
Удаляет из списка последний элемент, который был возвращён вызовом next() или previous() (необязательная операция). |
void |
set |
Заменяет последний элемент, возвращённый вызовом next() или previous(), указанным элементом (необязательная операция). |
Методы, объявленные в интерфейсе java.util.Iterator
forEachRemaining
Подробное описание методов
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- если какой-либо аспект этого элемента не позволяет добавить его в этот список
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ListIterator.html