org.openxml.util

Class TreeIterator

java.lang.Object

org.openxml.util.TreeIterator

public final class TreeIterator
extends Object

Implementation of a non-live node iterator. This iterator supports filtering and selective node return, traversing only to next node, and is not live with respect to changes in the document. This iterator can be used in instances that do not require a live node iterator, until tree iterators are formalized by the DOM.

Author:

Assaf Arkin

Constructor Summary

Constructors

Constructor and Description
TreeIterator(Node tree, int whatToShow) Constrctor for a new node iterator.

Method Summary

Modifier and Type	Method and Description
Node	nextNode() Returns the next node.

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeIterator

public TreeIterator(Node tree,
                    int whatToShow)

Constrctor for a new node iterator.

Parameters:

tree - The top of the node tree to iterate

whatToShow - Bit mask indicating what nodes to return

Method Detail

nextNode

public Node nextNode()

Returns the next node. Nodes are iterated in a depth-first order, returning only nodes that match the whatToShow mask. The first call will return first node in the tree. The top node of the tree is never returned. Once the tree has been exhuasted, this method will always return null.

Returns:

The next node in the tree, or null