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

Параметры типа:: E - тип элементов, возвращаемых этим итератором

Все известные подинтерфейсы:: EventIterator, ListIterator<E>, PrimitiveIterator<T,T_CONS>, PrimitiveIterator.OfDouble, PrimitiveIterator.OfInt, PrimitiveIterator.OfLong, XMLEventReader

Все известные реализующие классы:: BeanContextSupport.BCSIterator, EventReaderDelegate, Scanner

public interface Iterator<E>

Итератор по коллекции. Iterator заменяет Enumeration в Java Collections Framework. Итераторы отличаются от перечислений по двум параметрам:

Итераторы позволяют вызывающей стороне удалять элементы из базовой коллекции во время итерации со своими чётко определёнными семантиками.
Названия методов улучшены.

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

Примечание API:

Перечисление можно преобразовать в итератор, используя метод Enumeration.asIterator().

С:

1.2

См. также:

Краткое описание методов

Модификатор и тип	Метод	Описание
`default void`	`forEachRemaining(Consumer<? super E> action)`	Выполняет заданное действие для каждого оставшегося элемента, пока все элементы не будут обработаны или действие не выбросит исключение.
`boolean`	`hasNext()`	Возвращает `true` если итерация содержит больше элементов.
`E`	`next()`	Возвращает следующий элемент в итерации.
`default void`	`remove()`	Удаляет из базовой коллекции последний элемент, возвращенный этим итератором (необязательная операция).

Подробное описание методов

hasNext

boolean hasNext()

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

Возвращает:: true если итерация содержит больше элементов

E next()

Возвращает следующий элемент в итерации.

Возвращает:: следующий элемент в итерации
Исключения:: NoSuchElementException - если итерация не содержит больше элементов

remove

default void remove()

Удаляет из базовой коллекции последний элемент, возвращенный этим итератором (необязательная операция). Этот метод может быть вызван только один раз за вызов next().

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

Поведение итератора не определено, если этот метод вызывается после вызова метода forEachRemaining.

Требования к реализации:: Стандартная реализация выбрасывает экземпляр UnsupportedOperationException и не выполняет никаких других действий.
Исключения:: UnsupportedOperationException - если операция удаления не поддерживается этим итератором; IllegalStateException - если метод next не был вызван, или метод remove был вызван после последнего вызова метода next

forEachRemaining

default void forEachRemaining(Consumer<? super E> action)

Выполняет заданное действие для каждого оставшегося элемента, пока все элементы не будут обработаны или действие не выбросит исключение. Действия выполняются в порядке итерации, если этот порядок указан. Исключения, брошенные действием, передаются вызывающей стороне.

Поведение итератора не определено, если действие каким-либо образом изменяет коллекцию (даже вызывая метод remove или другие методы-мутаторы подтипов Iterator), если соответствующий класс не указал политику конкурентного изменения.

Последующее поведение итератора не определено, если действие выбросило исключение.

Требования к реализации:

Стандартная реализация ведёт себя так, как если бы:


     while (hasNext())
         action.accept(next());

Параметры:

action - действие, которое должно выполняться для каждого элемента

Исключения:

NullPointerException - если указанное действие равно null

С:

1.8

© 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/Iterator.html