Spec-Zone.ru › OpenJDK 24

Класс 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.

Методы, унаследованные от класса java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

ElementIterator

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

ElementIterator

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

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

clone

public Object clone()
Клонирует ElementIterator.
Overrides:
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, если доступен

© 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.desktop/javax/swing/text/ElementIterator.html

Spec-Zone.ru

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