Module org.htmlunit

Package org.htmlunit.platform.dom.traversal

Class DomTreeWalker

java.lang.Object

org.htmlunit.platform.dom.traversal.DomTreeWalker

All Implemented Interfaces:

TreeWalker

public class DomTreeWalker
extends Object
implements TreeWalker

An implementation of TreeWalker backed by HtmlDomTreeWalker.

Author:

Ronald Brill

See Also:

• DOM-Level-2-Traversal-Range

Constructor Summary

Constructors

Constructor	Description
DomTreeWalker(DomNode root, int whatToShow, NodeFilter filter, boolean expandEntityReferences)	Creates an instance.

Method Summary

Modifier and Type	Method	Description
DomNode	firstChild()
DomNode	getCurrentNode()
boolean	getExpandEntityReferences()
NodeFilter	getFilter()
DomNode	getRoot()
int	getWhatToShow()
DomNode	lastChild()
DomNode	nextNode()
DomNode	nextSibling()
DomNode	parentNode()
DomNode	previousNode()
DomNode	previousSibling()
void	setCurrentNode(Node currentNode)

Methods inherited from class java.lang.Object

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

Constructor Details

DomTreeWalker

public DomTreeWalker(DomNode root,
 int whatToShow,
 NodeFilter filter,
 boolean expandEntityReferences)
              throws DOMException

Creates an instance.

Parameters:

root - The root node of the TreeWalker. Must not be null.

whatToShow - Flag specifying which types of nodes appear in the logical view of the TreeWalker. See NodeFilter for the set of possible Show_ values.

filter - The NodeFilter to be used with this TreeWalker, or null to indicate no filter.

expandEntityReferences - If false, the contents of EntityReference nodes are not present in the logical view.

Throws:

DOMException - on attempt to create a TreeWalker with a root that is null.

Method Details

getRoot

public DomNode getRoot()

Specified by:

getRoot in interface TreeWalker

getWhatToShow

public int getWhatToShow()

Specified by:

getWhatToShow in interface TreeWalker

getFilter

public NodeFilter getFilter()

Specified by:

getFilter in interface TreeWalker

getExpandEntityReferences

public boolean getExpandEntityReferences()

Specified by:

getExpandEntityReferences in interface TreeWalker

getCurrentNode

public DomNode getCurrentNode()

Specified by:

getCurrentNode in interface TreeWalker

setCurrentNode

public void setCurrentNode(Node currentNode)
                    throws DOMException

Specified by:

setCurrentNode in interface TreeWalker

Throws:

DOMException

nextNode

public DomNode nextNode()

Specified by:

nextNode in interface TreeWalker

nextSibling

public DomNode nextSibling()

Specified by:

nextSibling in interface TreeWalker

parentNode

public DomNode parentNode()

Specified by:

parentNode in interface TreeWalker

previousSibling

public DomNode previousSibling()

Specified by:

previousSibling in interface TreeWalker

lastChild

public DomNode lastChild()

Specified by:

lastChild in interface TreeWalker

previousNode

public DomNode previousNode()

Specified by:

previousNode in interface TreeWalker

firstChild

public DomNode firstChild()

Specified by:

firstChild in interface TreeWalker