NodeHierarchicalVisitor (org.macroing.cit.java API)

All Known Implementing Classes:

AbstractReflectiveNodeHierarchicalVisitor
```
public interface NodeHierarchicalVisitor
```
A NodeHierarchicalVisitor is used for traversing the structure of a Node in a hierarchical fashion.
It uses a design pattern called Hierarchical Visitor.
This makes it possible to keep track of the current depth or skip a Nodes children or siblings.
Implement it in order to perform various operations on various Nodes in sequence.

Since:

1.0.0

Author:

Jörgen Lundgren

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`visitEnter(Node node)` Called by a concrete `Node` implementation.
`boolean`	`visitLeave(Node node)` Called by a concrete `Node` implementation.

- Method Detail
  - visitEnter
```
boolean visitEnter(Node node)
```
    Called by a concrete Node implementation.
    It should happen soon after its accept(NodeHierarchicalVisitor) method has been called, with this NodeHierarchicalVisitor as its parameter argument.
    If node is null, a NullPointerException may be thrown. But no guarantees can be made.
    If node could not be traversed by this NodeHierarchicalVisitor, a NodeTraversalException may be thrown. But no guarantees can be made.
    To visit nodes child Nodes, return true, false otherwise.
    
    Parameters:
    
    node - the Node to enter
    
    Returns:
    
    true if, and only if, nodes child Nodes should be visited, false otherwise
    
    Throws:
    
    NodeTraversalException - thrown if, and only if, node could not be traversed by this NodeHierarchicalVisitor
    
    java.lang.NullPointerException - thrown if, and only if, node is null
  - visitLeave
```
boolean visitLeave(Node node)
```
    Called by a concrete Node implementation.
    It should happen just before its accept(NodeHierarchicalVisitor) method returns. Actually, it should be the result returned by that method.
    If node is null, a NullPointerException may be thrown. But no guarantees can be made.
    If node could not be traversed by this NodeHierarchicalVisitor, a NodeTraversalException may be thrown. But no guarantees can be made.
    To visit nodes sibling Nodes, return true, false otherwise.
    
    Parameters:
    
    node - the Node to leave
    
    Returns:
    
    true if, and only if, nodes sibling Nodes should be visited, false otherwise
    
    Throws:
    
    NodeTraversalException - thrown if, and only if, node could not be traversed by this NodeHierarchicalVisitor
    
    java.lang.NullPointerException - thrown if, and only if, node is null

Interface NodeHierarchicalVisitor

Method Summary

Method Detail

visitEnter

visitLeave