Class DefaultConfigurationNode.SubNodes
- java.lang.Object
-
- org.apache.commons.configuration.tree.DefaultConfigurationNode.SubNodes
-
- Enclosing class:
- DefaultConfigurationNode
protected static class DefaultConfigurationNode.SubNodes extends java.lang.Object
An internally used helper class for managing a collection of sub nodes.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
SubNodes()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addNode(ConfigurationNode node)
Adds a new sub node.void
clear()
Removes all sub nodes.protected void
detachNode(ConfigurationNode subNode)
This method is called whenever a sub node is removed from this object.protected void
detachNodes(java.util.Collection<? extends ConfigurationNode> subNodes)
Detaches a list of sub nodes.ConfigurationNode
getNode(int index)
Returns the node with the given index.java.util.List<ConfigurationNode>
getSubNodes()
Returns a list with all stored sub nodes.java.util.List<ConfigurationNode>
getSubNodes(java.lang.String name)
Returns a list of the sub nodes with the given name.boolean
removeNode(ConfigurationNode node)
Removes a sub node.boolean
removeNodes(java.lang.String name)
Removes all sub nodes with the given name.void
visit(ConfigurationNodeVisitor visitor)
Let the passed in visitor visit all sub nodes.
-
-
-
Constructor Detail
-
SubNodes
protected SubNodes()
-
-
Method Detail
-
addNode
public void addNode(ConfigurationNode node)
Adds a new sub node.- Parameters:
node
- the node to add
-
removeNode
public boolean removeNode(ConfigurationNode node)
Removes a sub node.- Parameters:
node
- the node to remove- Returns:
- a flag if the node could be removed
-
removeNodes
public boolean removeNodes(java.lang.String name)
Removes all sub nodes with the given name.- Parameters:
name
- the name- Returns:
- a flag if at least on sub node was removed
-
clear
public void clear()
Removes all sub nodes.
-
getNode
public ConfigurationNode getNode(int index)
Returns the node with the given index. If this index cannot be found, anIndexOutOfBoundException
exception will be thrown.- Parameters:
index
- the index (0-based)- Returns:
- the sub node at the specified index
-
getSubNodes
public java.util.List<ConfigurationNode> getSubNodes()
Returns a list with all stored sub nodes. The return value is never null.- Returns:
- a list with the sub nodes
-
getSubNodes
public java.util.List<ConfigurationNode> getSubNodes(java.lang.String name)
Returns a list of the sub nodes with the given name. The return value is never null.- Parameters:
name
- the name; if null is passed, all sub nodes will be returned- Returns:
- all sub nodes with this name
-
visit
public void visit(ConfigurationNodeVisitor visitor)
Let the passed in visitor visit all sub nodes.- Parameters:
visitor
- the visitor
-
detachNode
protected void detachNode(ConfigurationNode subNode)
This method is called whenever a sub node is removed from this object. It ensures that the removed node's parent is reset and itsremoveReference()
method gets called.- Parameters:
subNode
- the node to be removed
-
detachNodes
protected void detachNodes(java.util.Collection<? extends ConfigurationNode> subNodes)
Detaches a list of sub nodes. This method callsdetachNode()
for each node contained in the list.- Parameters:
subNodes
- the list with nodes to be detached
-
-