public class ElementIterator extends Object implements Cloneable
ElementIterator, as the name suggests, iteratates over the Element tree. The constructor can be invoked with either Document or an Element as an argument. If the constructor is invoked with a Document as an argument then the root of the iteration is the return value of document.getDefaultRootElement(). The iteration happens in a depth-first manner. In terms of how boundary conditions are handled: a) if next() is called before first() or current(), the root will be returned. b) next() returns null to indicate the end of the list. c) previous() returns null when the current element is the root or next() has returned null. The ElementIterator does no locking of the Element tree. This means that it does not track any changes. It is the responsibility of the user of this class, to ensure that no changes happen during element iteration. Simple usage example: 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; } } }
| Constructor and Description |
|---|
ElementIterator(Document document)
Creates a new ElementIterator.
|
ElementIterator(Element root)
Creates a new ElementIterator.
|
| Modifier and Type | Method and Description |
|---|---|
Object |
clone()
Clones the ElementIterator.
|
Element |
current()
Fetches the current Element.
|
int |
depth()
Fetches the current depth of element tree.
|
Element |
first()
Fetches the first element.
|
Element |
next()
Fetches the next Element.
|
Element |
previous()
Fetches the previous Element.
|
public ElementIterator(Document document)
document - a Document.public ElementIterator(Element root)
root - the root Element.public Object clone()
public Element first()
public int depth()
public Element current()
null if the root element is nullpublic Element next()
null
at the end of the list.public Element previous()
Element if available Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138