Spec-Zone.ru › OpenJDK 24

Интерфейс 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
См. также:
  • 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

© 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://download.java.net/java/early_access/jdk24/docs/api/java.base/java/util/Iterator.html

Spec-Zone.ru

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