Spec-Zone.ru › OpenJDK 27

Класс ElementIterator

java.lang.Object
javax.swing.text.ElementIterator
Все реализуемые интерфейсы:
Cloneable
public class ElementIterator extends Object implements Cloneable
ElementIterator, как следует из названия, выполняет итерацию по дереву Element. Конструктор можно вызвать, передав в качестве аргумента либо Document, либо Element. Если конструктор вызван с аргументом Document, корнем итерации становится возвращаемое значение document.getDefaultRootElement().

Итерация выполняется в глубину. Граничные условия обрабатываются следующим образом:

  • если вызов next() выполняется до вызова first() или current(), будет возвращен корневой элемент
  • next() возвращает null, указывая на конец списка
  • previous() возвращает null, если текущий элемент является корневым или next() вернул null

ElementIterator не блокирует дерево Element. Это означает, что он не отслеживает изменения. Пользователь этого класса отвечает за то, чтобы во время итерации по элементам не происходило никаких изменений.

Пример простого использования:

public void iterate() {
     ElementIterator it = new ElementIterator(root);
     Element elem;
     while (true) {
         if ((elem = it.next()) != null) {
             // process element
             System.out.println("elem: " + elem.getName());
         } else {
             break;
         }
     }
}

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

Конструктор Описание
ElementIterator(Document document)
Создает новый ElementIterator.
ElementIterator(Element root)
Создает новый ElementIterator.

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

Модификатор и тип Метод Описание
Object clone()
Клонирует ElementIterator.
Element current()
Получает текущий Element.
int depth()
Получает текущую глубину дерева элементов.
Element first()
Получает первый элемент.
Element next()
Получает следующий Element.
Element previous()
Получает предыдущий Element.

Методы, объявленные в классе Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Модификатор и тип Метод Описание
boolean equals(Object obj)
Показывает, равен ли этот объект какому-либо другому объекту.
protected void finalize()
Устарел, будет удален: этот элемент API может быть удален в будущей версии.
Финализация устарела и может быть удалена в одном из будущих выпусков.
final Class<?> getClass()
Возвращает класс времени выполнения этого Object.
int hashCode()
Возвращает хеш-код этого объекта.
final void notify()
Пробуждает один поток, ожидающий на мониторе этого объекта.
final void notifyAll()
Пробуждает все потоки, ожидающие на мониторе этого объекта.
String toString()
Возвращает строковое представление объекта.
final void wait()
Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt.
final void wait(long timeoutMillis)
Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо истечения определенного промежутка реального времени.
final void wait(long timeoutMillis, int nanos)
Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо истечения определенного промежутка реального времени.

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

ElementIterator

public ElementIterator(Document document)
Создает новый ElementIterator. Корневой элемент берется из документа в качестве его корневого элемента по умолчанию.
Параметры:
document — Document

ElementIterator

public ElementIterator(Element root)
Создает новый ElementIterator.
Параметры:
root — корневой Element

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

clone

public Object clone()
Клонирует ElementIterator.
Переопределяет:
clone в классе Object
Возвращает:
клонированный объект ElementIterator
См. также:
  • Cloneable

first

public Element first()
Получает первый элемент.
Возвращает:
элемент Element

depth

public int depth()
Получает текущую глубину дерева элементов.
Возвращает:
глубину

current

public Element current()
Получает текущий Element.
Возвращает:
элемент на вершине стека или null, если корневой элемент null

next

public Element next()
Получает следующий Element. Для поиска следующего элемента используется обход в глубину.
Возвращает:
следующий элемент или null в конце списка

previous

public Element previous()
Получает предыдущий Element. Однако если текущий элемент является последним элементом или текущий элемент — null, возвращается null.
Возвращает:
предыдущий Element, если он доступен

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, включая концептуальные обзоры, определения терминов, способы обхода проблем и работающие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторское право © 1993, 2026, 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.

Spec-Zone.ru

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