Spec-Zone.ru › OpenJDK 25

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

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

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

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторские права © 1993, 2025, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, 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/25/docs/api/java.base/java/util/Iterator.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API