org.w3c.dom.traversal
Interface DocumentTraversal

All Known Implementing Classes:

XMLDocument

public interface DocumentTraversal

DocumentTraversal contains methods that create iterators and tree-walkers to traverse a node and its children in document order (depth first, pre-order traversal, which is equivalent to the order in which the start tags occur in the text representation of the document). In DOMs which support the Traversal feature, DocumentTraversal will be implemented by the same objects that implement the Document interface.

See also the Document Object Model (DOM) Level 2 Traversal and Range Specification.

Since:

DOM Level 2

Method Summary

NodeIterator	createNodeIterator(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) Create a new NodeIterator over the subtree rooted at the specified node.
TreeWalker	createTreeWalker(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion) Create a new TreeWalker over the subtree rooted at the specified node.

Method Detail

createNodeIterator

public NodeIterator createNodeIterator(Node root,
                                       int whatToShow,
                                       NodeFilter filter,
                                       boolean entityReferenceExpansion)
                                throws DOMException

Create a new NodeIterator over the subtree rooted at the specified node.

Returns:

The newly created NodeIterator.

Throws:

DOMException - NOT_SUPPORTED_ERR: Raised if the specified root is null.

createTreeWalker

public TreeWalker createTreeWalker(Node root,
                                   int whatToShow,
                                   NodeFilter filter,
                                   boolean entityReferenceExpansion)
                            throws DOMException

Create a new TreeWalker over the subtree rooted at the specified node.

Returns:

The newly created TreeWalker.

Throws:

DOMException - NOT_SUPPORTED_ERR: Raised if the specified root is null.