Класс ElementIterator
- java.lang.Object
-
- javax.swing.text.ElementIterator
- Все реализованные интерфейсы:
Cloneable
public class ElementIterator extends Object implements Cloneable
ElementIterator, как следует из названия, выполняет итерацию по дереву элементов. Конструктор может быть вызван с документом или элементом в качестве аргумента. Если конструктор вызывается с документом в качестве аргумента, то корнем итерации является возвращаемое значение document.getDefaultRootElement(). Итерация происходит в порядке обхода в глубину. Что касается обработки граничных условий: а) если next() вызывается до first() или current(), возвращается корень. б) next() возвращает null, чтобы указать конец списка. в) previous() возвращает null, когда текущий элемент является корнем или next() вернул null. ElementIterator не выполняет блокировку дерева элементов. Это означает, что он не отслеживает изменения. Пользователь этого класса отвечает за обеспечение того, чтобы во время итерации элементов не происходило изменений. Простой пример использования: public void iterate() { ElementIterator it = new ElementIterator(root); Element elem; while (true) { if ((elem = 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() | Извлекает текущий элемент. |
int | depth() | Извлекает текущую глубину дерева элементов. |
Element | first() | Извлекает первый элемент. |
Element | next() | Извлекает следующий элемент. |
Element | previous() | Извлекает предыдущий элемент. |
Методы, объявленные в классе java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait Подробное описание конструкторов
ElementIterator
public ElementIterator(Document document)
Создает новый ElementIterator. Корневой элемент берется для получения корневого элемента документа по умолчанию.
- Параметры:
-
document- документ.
ElementIterator
public ElementIterator(Element root)
Создает новый ElementIterator.
- Параметры:
-
root- корневой элемент.
Подробное описание методов
clone
public Object clone()
Клонирует ElementIterator.
- Переопределяет:
-
cloneв классеObject - Возвращает:
- клонированный объект ElementIterator.
- См. также:
Cloneable
first
public Element first()
Извлекает первый элемент.
- Возвращает:
- элемент.
depth
public int depth()
Извлекает текущую глубину дерева элементов.
- Возвращает:
- глубину.
current
public Element current()
Извлекает текущий элемент.
- Возвращает:
- элемент вверху стека или
nullесли корневой элементnull
next
public Element next()
Извлекает следующий элемент. Стратегия, используемая для поиска следующего элемента, представляет собой поиск в глубину.
- Возвращает:
- следующий элемент или
nullв конце списка.
previous
public Element previous()
Извлекает предыдущий элемент. Однако, если текущий элемент является последним или текущий элемент равен null, то возвращается null.
- Возвращает:
- предыдущий
Elementесли доступен
© 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.desktop/javax/swing/text/ElementIterator.html