- java.lang.Object
- 
- javax.swing.text.ElementIterator
 
- 
- All Implemented Interfaces:
- Cloneable
 
 public class ElementIterator extends Object implements Cloneable 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; } } } 
- 
- 
Constructor SummaryConstructors Constructor Description ElementIterator(Document document)Creates a new ElementIterator.ElementIterator(Element root)Creates a new ElementIterator.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description Objectclone()Clones the ElementIterator.Elementcurrent()Fetches the current Element.intdepth()Fetches the current depth of element tree.Elementfirst()Fetches the first element.Elementnext()Fetches the next Element.Elementprevious()Fetches the previous Element.
 
- 
- 
- 
Constructor Detail- 
ElementIteratorpublic ElementIterator(Document document) Creates a new ElementIterator. The root element is taken to get the default root element of the document.- Parameters:
- document- a Document.
 
 - 
ElementIteratorpublic ElementIterator(Element root) Creates a new ElementIterator.- Parameters:
- root- the root Element.
 
 
- 
 - 
Method Detail- 
clonepublic Object clone() Clones the ElementIterator.
 - 
firstpublic Element first() Fetches the first element.- Returns:
- an Element.
 
 - 
depthpublic int depth() Fetches the current depth of element tree.- Returns:
- the depth.
 
 - 
currentpublic Element current() Fetches the current Element.- Returns:
- element on top of the stack or
          nullif the root element isnull
 
 - 
nextpublic Element next() Fetches the next Element. The strategy used to locate the next element is a depth-first search.- Returns:
- the next element or nullat the end of the list.
 
 - 
previouspublic Element previous() 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 Elementif available
 
 
- 
 
-