Package org.apache.commons.configuration
Class HierarchicalConfiguration.NodeVisitor
java.lang.Object
org.apache.commons.configuration.HierarchicalConfiguration.NodeVisitor
- Direct Known Subclasses:
HierarchicalConfiguration.BuilderVisitor
- Enclosing class:
HierarchicalConfiguration
Definition of a visitor class for traversing a node and all of its children.
This class defines the interface of a visitor for
Node
objects and provides a default implementation. The
method visit()
of Node
implements a generic
iteration algorithm based on the Visitor pattern. By providing
different implementations of visitors it is possible to collect different
data during the iteration process.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns a flag that indicates if iteration should be stopped.void
Visits the specified node after its children have been processed.void
Visits the specified node.
-
Constructor Details
-
NodeVisitor
public NodeVisitor()
-
-
Method Details
-
visitBeforeChildren
Visits the specified node. This method is called during iteration for each node before its children have been visited.- Parameters:
node
- the actual nodekey
- the key of this node (may be null )
-
visitAfterChildren
Visits the specified node after its children have been processed. This gives a visitor the opportunity of collecting additional data after the child nodes have been visited.- Parameters:
node
- the node to be visitedkey
- the key of this node (may be null )
-
terminate
Returns a flag that indicates if iteration should be stopped. This method is called after each visited node. It can be useful for visitors that search a specific node. If this node is found, the whole process can be stopped. This base implementation always returns false .- Returns:
- a flag if iteration should be stopped
-