gnu.xml.dom

Class DomIterator

public final class DomIterator extends Object implements NodeIterator, EventListener

"NodeIterator" implementation, usable with any L2 DOM which supports MutationEvents.

Version: $Date: 2001/11/20 04:57:05 $

Author: David Brownell

Constructor Summary
protected DomIterator(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion)
Constructs and initializes an iterator.
Method Summary
voiddetach()
DOM L2 Flags the iterator as done, unregistering its event listener so that the iterator can be garbage collected without relying on weak references (a "Java 2" feature) in the event subsystem.
booleangetExpandEntityReferences()
DOM L2 Returns the flag controlling whether iteration descends through entity references.
NodeFiltergetFilter()
DOM L2 Returns the filter provided during construction.
NodegetRoot()
DOM L2 Returns the root of the tree this is iterating through.
intgetWhatToShow()
DOM L2 Returns the mask of flags provided during construction.
voidhandleEvent(Event e)
Not for public use.
NodenextNode()
DOM L2 Returns the next node in a forward iteration, masked and filtered.
NodepreviousNode()
DOM L2 Returns the next node in a backward iteration, masked and filtered.

Constructor Detail

DomIterator

protected DomIterator(Node root, int whatToShow, NodeFilter filter, boolean entityReferenceExpansion)
Constructs and initializes an iterator.

Method Detail

detach

public void detach()
DOM L2 Flags the iterator as done, unregistering its event listener so that the iterator can be garbage collected without relying on weak references (a "Java 2" feature) in the event subsystem.

getExpandEntityReferences

public boolean getExpandEntityReferences()
DOM L2 Returns the flag controlling whether iteration descends through entity references.

getFilter

public NodeFilter getFilter()
DOM L2 Returns the filter provided during construction.

getRoot

public Node getRoot()
DOM L2 Returns the root of the tree this is iterating through.

getWhatToShow

public int getWhatToShow()
DOM L2 Returns the mask of flags provided during construction.

handleEvent

public void handleEvent(Event e)
Not for public use. This lets the iterator know when its reference node will be removed from the tree, so that a new one may be selected.

This version works by watching removal events as they bubble up. So, don't prevent them from bubbling.

nextNode

public Node nextNode()
DOM L2 Returns the next node in a forward iteration, masked and filtered. Note that the node may be read-only due to entity expansions. A null return indicates the iteration is complete, but may still be processed backwards.

previousNode

public Node previousNode()
DOM L2 Returns the next node in a backward iteration, masked and filtered. Note that the node may be read-only due to entity expansions. A null return indicates the iteration is complete, but may still be processed forwards.

Source code is under GPL (with library exception) in the JAXP project at http://www.gnu.org/software/classpathx/jaxp
This documentation was derived from that source code on 2013-01-12.