NodeTreeWalker

java.lang.Object
- org.htmlparser.util.NodeTreeWalker

所有已实现的接口:

NodeIterator
```
public class NodeTreeWalker
extends java.lang.Object
implements NodeIterator
```
A class for walking a tree of Node objects, in either a depth-first or breadth-first manner. The following two diagrams show the represent tree traversal with the two different methods.

作者:

ian_macfarlane

构造器概要

构造器
构造器和说明
`NodeTreeWalker(Node rootNode)` Creates a new instance of NodeTreeWalker using depth-first tree traversal, without limits on how deep it may traverse.
`NodeTreeWalker(Node rootNode, boolean depthFirst)` Creates a new instance of NodeTreeWalker using the specified type of tree traversal, without limits on how deep it may traverse.
`NodeTreeWalker(Node rootNode, boolean depthFirst, int maxDepth)` Creates a new instance of NodeTreeWalker using the specified type of tree traversal and maximum depth from the root Node to traverse.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Node`	`getCurrentNode()` Get the Node in the tree that the NodeTreeWalker is current at.
`int`	`getCurrentNodeDepth()` Get the number of places down that the current Node is from the root Node.
`int`	`getMaxDepth()` The maximum depth (number of child-parent links) below the root Node that this NodeTreeWalker may traverse.
`Node`	`getRootNode()` Get the root Node that defines the scope of the tree to traverse.
`boolean`	`hasMoreNodes()` Returns whether or not there are more nodes available based on the current configuration of this NodeTreeWalker.
`boolean`	`isDepthFirst()` Whether the NodeTreeWalker is currently set to use depth-first or breadth-first tree traversal.
`Node`	`nextNode()` Traverses to the next Node from the current Node, using either depth-first or breadth-first tree traversal as appropriate.
`void`	`removeMaxDepthRestriction()` Removes any restrictions in place that prevent this NodeTreeWalker from traversing beyond a certain depth.
`void`	`reset()` Resets the current position in the tree, such that calling `nextNode()` will return the first Node again.
`void`	`setCurrentNodeAsRootNode()` Sets the current Node as the root Node.
`void`	`setDepthFirst(boolean depthFirst)` Sets whether the NodeTreeWalker should use depth-first or breadth-first tree traversal.
`void`	`setRootNode(Node rootNode)` Sets the specified Node as the root Node.

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - NodeTreeWalker
```
public NodeTreeWalker(Node rootNode)
```
    Creates a new instance of NodeTreeWalker using depth-first tree traversal, without limits on how deep it may traverse.
    
    参数:
    
    rootNode - Node The Node to set as the root of the tree.
    
    抛出:
    
    java.lang.NullPointerException - if root Node is null.
  - NodeTreeWalker
```
public NodeTreeWalker(Node rootNode,
                      boolean depthFirst)
```
    Creates a new instance of NodeTreeWalker using the specified type of tree traversal, without limits on how deep it may traverse.
    
    参数:
    
    rootNode - The Node to set as the root of the tree.
    
    depthFirst - Whether to use depth-first (true) or breadth-first (false) tree traversal.
    
    抛出:
    
    java.lang.NullPointerException - if rootNode is null.
  - NodeTreeWalker
```
public NodeTreeWalker(Node rootNode,
                      boolean depthFirst,
                      int maxDepth)
```
    Creates a new instance of NodeTreeWalker using the specified type of tree traversal and maximum depth from the root Node to traverse.
    
    参数:
    
    rootNode - The Node to set as the root of the tree.
    
    depthFirst - Whether to use depth-first (true) or breadth-first (false) tree traversal.
    
    maxDepth - The maximum depth from the root Node that this NodeTreeWalker may traverse. This must be > 0 or equal to -1.
    
    抛出:
    
    java.lang.NullPointerException - if rootNode is null.
    
    java.lang.IllegalArgumentException - maxDepth is not > 0 or equal to -1.
- 方法详细资料
  - isDepthFirst
```
public boolean isDepthFirst()
```
    Whether the NodeTreeWalker is currently set to use depth-first or breadth-first tree traversal.
    
    返回:
    
    True if depth-first tree-traversal is used, or false if breadth-first tree-traversal is being used.
  - setDepthFirst
```
public void setDepthFirst(boolean depthFirst)
```
    Sets whether the NodeTreeWalker should use depth-first or breadth-first tree traversal.
    
    参数:
    
    depthFirst - Whether to use depth-first (true) or breadth-first (false) tree traversal.
  - getMaxDepth
```
public int getMaxDepth()
```
    The maximum depth (number of child-parent links) below the root Node that this NodeTreeWalker may traverse.
    
    返回:
    
    The maximum depth that this NodeTreeWalker can traverse to.
  - removeMaxDepthRestriction
```
public void removeMaxDepthRestriction()
```
    Removes any restrictions in place that prevent this NodeTreeWalker from traversing beyond a certain depth.
  - getRootNode
```
public Node getRootNode()
```
    Get the root Node that defines the scope of the tree to traverse.
    
    返回:
    
    The root Node.
  - getCurrentNode
```
public Node getCurrentNode()
```
    Get the Node in the tree that the NodeTreeWalker is current at.
    
    返回:
    
    The current Node.
  - setCurrentNodeAsRootNode
```
public void setCurrentNodeAsRootNode()
                              throws java.lang.NullPointerException
```
    Sets the current Node as the root Node. Resets the current position in the tree.
    
    抛出:
    
    java.lang.NullPointerException - if the current Node is null (i.e. if the tree traversal has not yet begun).
  - setRootNode
```
public void setRootNode(Node rootNode)
                 throws java.lang.NullPointerException
```
    Sets the specified Node as the root Node. Resets the current position in the tree.
    
    参数:
    
    rootNode - The Node to set as the root of the tree.
    
    抛出:
    
    java.lang.NullPointerException - if rootNode is null.
  - reset
```
public void reset()
```
    Resets the current position in the tree, such that calling nextNode() will return the first Node again.
  - nextNode
```
public Node nextNode()
```
    Traverses to the next Node from the current Node, using either depth-first or breadth-first tree traversal as appropriate.
    
    指定者:
    
    nextNode 在接口中 NodeIterator
    
    返回:
    
    The next Node from the current Node.
  - getCurrentNodeDepth
```
public int getCurrentNodeDepth()
```
    Get the number of places down that the current Node is from the root Node. Returns 1 if current Node is a child of the root Node. Returns 0 if this NodeTreeWalker has not yet traversed to any Nodes.
    
    返回:
    
    The depth the current Node is from the root Node.
  - hasMoreNodes
```
public boolean hasMoreNodes()
```
    Returns whether or not there are more nodes available based on the current configuration of this NodeTreeWalker.
    
    指定者:
    
    hasMoreNodes 在接口中 NodeIterator
    
    返回:
    
    True if there are more Nodes available, based on the current configuration, or false otherwise.

类 NodeTreeWalker

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

NodeTreeWalker

NodeTreeWalker

NodeTreeWalker

方法详细资料

isDepthFirst

setDepthFirst

getMaxDepth

removeMaxDepthRestriction

getRootNode

getCurrentNode

setCurrentNodeAsRootNode

setRootNode

reset

nextNode

getCurrentNodeDepth

hasMoreNodes