javax.swing.text.ElementIterator
ElementIterator, as the name suggests, iterates 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; } } }
ElementIterator, as the name suggests, iterates 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;
}
}
}->element-iteratorclj
(->element-iterator document)Constructor.
Creates a new ElementIterator. The root element is taken to get the default root element of the document.
document - a Document. - javax.swing.text.Document
Constructor. Creates a new ElementIterator. The root element is taken to get the default root element of the document. document - a Document. - `javax.swing.text.Document`
cloneclj
(clone this)Clones the ElementIterator.
returns: a cloned ElementIterator Object. - java.lang.Object
Clones the ElementIterator. returns: a cloned ElementIterator Object. - `java.lang.Object`
currentclj
(current this)Fetches the current Element.
returns: element on top of the stack or
null if the root element is null - javax.swing.text.Element
Fetches the current Element.
returns: element on top of the stack or
null if the root element is null - `javax.swing.text.Element`depthclj
(depth this)Fetches the current depth of element tree.
returns: the depth. - int
Fetches the current depth of element tree. returns: the depth. - `int`
firstclj
(first this)Fetches the first element.
returns: an Element. - javax.swing.text.Element
Fetches the first element. returns: an Element. - `javax.swing.text.Element`
nextclj
(next this)Fetches the next Element. The strategy used to locate the next element is a depth-first search.
returns: the next element or null
at the end of the list. - javax.swing.text.Element
Fetches the next Element. The strategy
used to locate the next element is
a depth-first search.
returns: the next element or null
at the end of the list. - `javax.swing.text.Element`previousclj
(previous this)Fetches the previous Element. If however the current element is the last element, or the current element is null, then null is returned.
returns: previous Element if available - javax.swing.text.Element
Fetches the previous Element. If however the current element is the last element, or the current element is null, then null is returned. returns: previous Element if available - `javax.swing.text.Element`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close