Class NodeIteratorImpl

java.lang.Object
org.apache.xerces.dom.NodeIteratorImpl
All Implemented Interfaces:
NodeIterator

public class NodeIteratorImpl extends Object implements NodeIterator
DefaultNodeIterator implements a NodeIterator, which iterates a DOM tree in the expected depth first way.

The whatToShow and filter functionality is implemented as expected.

This class also has method removeNode to enable iterator "fix-up" on DOM remove. It is expected that the DOM implementation call removeNode right before the actual DOM transformation. If not called by the DOM, the client could call it before doing the removal.

INTERNAL:

Usage of this class is not supported. It may be altered or removed at any time.
Version:
$Id: NodeIteratorImpl.java 447266 2006-09-18 05:57:49Z mrglavas $
  • Constructor Details

    • NodeIteratorImpl

      public NodeIteratorImpl(DocumentImpl document, Node root, int whatToShow, NodeFilter nodeFilter, boolean entityReferenceExpansion)
      Public constructor
  • Method Details

    • getRoot

      public Node getRoot()
      Specified by:
      getRoot in interface NodeIterator
    • getWhatToShow

      public int getWhatToShow()
      Return the whatToShow value
      Specified by:
      getWhatToShow in interface NodeIterator
    • getFilter

      public NodeFilter getFilter()
      Return the filter
      Specified by:
      getFilter in interface NodeIterator
    • getExpandEntityReferences

      public boolean getExpandEntityReferences()
      Return whether children entity references are included in the iterator.
      Specified by:
      getExpandEntityReferences in interface NodeIterator
    • nextNode

      public Node nextNode()
      Return the next Node in the Iterator. The node is the next node in depth-first order which also passes the filter, and whatToShow. If there is no next node which passes these criteria, then return null.
      Specified by:
      nextNode in interface NodeIterator
    • previousNode

      public Node previousNode()
      Return the previous Node in the Iterator. The node is the next node in _backwards_ depth-first order which also passes the filter, and whatToShow.
      Specified by:
      previousNode in interface NodeIterator
    • removeNode

      public void removeNode(Node node)
      Fix-up the iterator on a remove. Called by DOM or otherwise, before an actual DOM remove.
    • detach

      public void detach()
      Specified by:
      detach in interface NodeIterator