org.apache.commons.configuration
Class HierarchicalConfiguration.DefinedVisitor

java.lang.Object
  org.apache.commons.configuration.HierarchicalConfiguration.NodeVisitor
      org.apache.commons.configuration.HierarchicalConfiguration.DefinedVisitor

Enclosing class:

HierarchicalConfiguration

static class HierarchicalConfiguration.DefinedVisitor

extends HierarchicalConfiguration.NodeVisitor

A specialized visitor that checks if a node is defined. "Defined" in this terms means that the node or at least one of its sub nodes is associated with a value.

Author:

Oliver Heger

Field Summary

private boolean

defined Stores the defined flag.

Constructor Summary

(package private)

HierarchicalConfiguration.DefinedVisitor()

Method Summary

boolean	isDefined() Returns the defined flag.
boolean	terminate() Checks if iteration should be stopped.
void	visitBeforeChildren(HierarchicalConfiguration.Node node, ConfigurationKey key) Visits the node.

Methods inherited from class org.apache.commons.configuration.HierarchicalConfiguration.NodeVisitor

visitAfterChildren

Methods inherited from class java.lang.Object

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

Field Detail

defined

private boolean defined

Stores the defined flag.

Constructor Detail

HierarchicalConfiguration.DefinedVisitor

HierarchicalConfiguration.DefinedVisitor()

Method Detail

terminate

public boolean terminate()

Checks if iteration should be stopped. This can be done if the first defined node is found.

Overrides:

terminate in class HierarchicalConfiguration.NodeVisitor

Returns:

a flag if iteration should be stopped

visitBeforeChildren

public void visitBeforeChildren(HierarchicalConfiguration.Node node,
                                ConfigurationKey key)

Visits the node. Checks if a value is defined.

Overrides:

visitBeforeChildren in class HierarchicalConfiguration.NodeVisitor

Parameters:

node - the actual node

key - the key of this node

isDefined

public boolean isDefined()

Returns the defined flag.

Returns:

the defined flag