Интерфейс 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:

Перечисление может быть преобразовано в Iterator с использованием метода 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 - если операция remove не поддерживается этим итератором; 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, 2023, 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/21/docs/api/java.base/java/util/Iterator.html