Class DomNodeIterator

public DomNodeIterator(Node root,
                       int whatToShow,
                       NodeFilter filter,
                       boolean entityReferenceExpansion,
                       boolean walk)

public void detach()

Detaches the NodeIterator from the set which it iterated over, releasing any computational resources and placing the NodeIterator in the INVALID state. After detach has been invoked, calls to nextNode or previousNode will raise the exception INVALID_STATE_ERR.

Specified by:

detach in interface NodeIterator

public Node firstChild()

Specified by:

firstChild in interface TreeWalker

public Node getCurrentNode()

Specified by:

getCurrentNode in interface TreeWalker

public boolean getExpandEntityReferences()

The value of this flag determines whether the children of entity reference nodes are visible to the NodeIterator. If false, these children and their descendants will be rejected. Note that this rejection takes precedence over whatToShow and the filter. Also note that this is currently the only situation where NodeIterators may reject a complete subtree rather than skipping individual nodes.

To produce a view of the document that has entity references expanded and does not expose the entity reference node itself, use the whatToShow flags to hide the entity reference node and set expandEntityReferences to true when creating the NodeIterator. To produce a view of the document that has entity reference nodes but no entity expansion, use the whatToShow flags to show the entity reference node and set expandEntityReferences to false.

Specified by:

getExpandEntityReferences in interface NodeIterator

getExpandEntityReferences in interface TreeWalker

public NodeFilter getFilter()

The NodeFilter used to screen nodes.

Specified by:

getFilter in interface NodeIterator

getFilter in interface TreeWalker

public Node getRoot()

The root node of the NodeIterator, as specified when it was created.

Specified by:

getRoot in interface NodeIterator

getRoot in interface TreeWalker

public int getWhatToShow()

This attribute determines which node types are presented via the NodeIterator. The available set of constants is defined in the NodeFilter interface. Nodes not accepted by whatToShow will be skipped, but their children may still be considered. Note that this skip takes precedence over the filter, if any.

Specified by:

getWhatToShow in interface NodeIterator

getWhatToShow in interface TreeWalker

public Node lastChild()

Specified by:

lastChild in interface TreeWalker

public Node nextNode()
            throws DOMException

Returns the next node in the set and advances the position of the NodeIterator in the set. After a NodeIterator is created, the first call to nextNode() returns the first node in the set.

Specified by:

nextNode in interface NodeIterator

nextNode in interface TreeWalker

Returns:

The next Node in the set being iterated over, or null if there are no more members in that set.

Throws:

DOMException - INVALID_STATE_ERR: Raised if this method is called after the detach method was invoked.

public Node nextSibling()

Specified by:

nextSibling in interface TreeWalker

public Node parentNode()

Specified by:

parentNode in interface TreeWalker

public Node previousNode()
            throws DOMException

Returns the previous node in the set and moves the position of the NodeIterator backwards in the set.

Specified by:

previousNode in interface NodeIterator

previousNode in interface TreeWalker

Returns:

The previous Node in the set being iterated over, or null if there are no more members in that set.

Throws:

DOMException - INVALID_STATE_ERR: Raised if this method is called after the detach method was invoked.

public Node previousSibling()

Specified by:

previousSibling in interface TreeWalker

public void setCurrentNode(Node current)
            throws DOMException

Specified by:

setCurrentNode in interface TreeWalker