Интерфейс 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 может быть преобразовано в Iterator с помощью метода Enumeration.asIterator().
С:
1.2
См. также:
Collection, ListIterator, Iterable

Методы

Модификатор и типМетодОписание
default voidforEachRemaining​(Consumer<? super E> action)

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

booleanhasNext()

Возвращает true , если итерация имеет ещё элементы.

Enext()

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

default voidremove()

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

Методы

hasNext

boolean hasNext()

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

Возвращает:
true , если итерация имеет ещё элементы

next

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, 2020, 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/11/docs/api/java.base/java/util/Iterator.html

Spec-Zone .ru
спецификации, руководства, описания, API