org.apache.commons.configuration.tree
public class DefaultConfigurationNode extends Object implements ConfigurationNode, Cloneable
A default implementation of the ConfigurationNode
interface.
Since: 1.3
Nested Class Summary | |
---|---|
protected static class | DefaultConfigurationNode.SubNodes
An internally used helper class for managing a collection of sub nodes. |
Field Summary | |
---|---|
boolean | attribute Stores a flag if this is an attribute. |
DefaultConfigurationNode.SubNodes | attributes Stores the attributes of this node. |
DefaultConfigurationNode.SubNodes | children Stores the children of this node. |
String | name Stores the name of this node. |
ConfigurationNode | parent Stores a reference to this node's parent. |
Object | reference Stores the reference. |
Object | value Stores the value of this node. |
Constructor Summary | |
---|---|
DefaultConfigurationNode()
Creates a new uninitialized instance of
DefaultConfigurationNode . | |
DefaultConfigurationNode(String name)
Creates a new instance of DefaultConfigurationNode and
initializes it with the node name.
| |
DefaultConfigurationNode(String name, Object value)
Creates a new instance of DefaultConfigurationNode and
initializes it with the name and a value.
|
Method Summary | |
---|---|
void | addAttribute(ConfigurationNode attr)
Adds the specified attribute to this node.
|
void | addChild(ConfigurationNode child)
Adds a new child to this node.
|
protected void | checkState()
Checks if a modification of this node is allowed. |
Object | clone()
Creates a copy of this object. |
protected DefaultConfigurationNode.SubNodes | createSubNodes(boolean attributes)
Creates a SubNodes instance that is used for storing
either this node's children or attributes.
|
ConfigurationNode | getAttribute(int index)
Returns the attribute with the given index.
|
int | getAttributeCount()
Returns the number of attributes contained in this node.
|
int | getAttributeCount(String name)
Returns the number of attributes of this node with the given name.
|
List | getAttributes()
Returns a list with the attributes of this node. |
List | getAttributes(String name)
Returns a list with all attributes of this node with the given name.
|
ConfigurationNode | getChild(int index)
Returns the child node with the given index.
|
List | getChildren()
Returns a list with all children of this node.
|
List | getChildren(String name)
Returns a list of all children with the given name.
|
int | getChildrenCount()
Returns the number of all children of this node.
|
int | getChildrenCount(String name)
Returns the number of children with the given name.
|
String | getName()
Returns the name of this node.
|
ConfigurationNode | getParentNode()
Returns a reference to this node's parent.
|
Object | getReference()
Returns the reference.
|
Object | getValue()
Returns the value of this node.
|
void | initSubNodes()
Helper method for initializing the sub nodes objects. |
boolean | isAttribute()
Checks if this node is an attribute node.
|
boolean | isDefined()
Returns a flag if this node is defined. |
boolean | removeAttribute(ConfigurationNode node)
Removes the specified attribute.
|
boolean | removeAttribute(String name)
Removes all attributes with the specified name.
|
void | removeAttributes()
Removes all attributes of this node. |
boolean | removeChild(ConfigurationNode child)
Removes the specified child node from this node.
|
boolean | removeChild(String childName)
Removes all children with the given name.
|
void | removeChildren()
Removes all child nodes of this node. |
protected void | removeReference()
Deals with the reference when a node is removed. |
void | setAttribute(boolean f)
Sets the attribute flag. |
void | setName(String name)
Sets the name of this node.
|
void | setParentNode(ConfigurationNode parent)
Sets the parent of this node.
|
void | setReference(Object reference)
Sets the reference.
|
void | setValue(Object val)
Sets the value of this node.
|
void | visit(ConfigurationNodeVisitor visitor)
Visits this node and all its sub nodes.
|
DefaultConfigurationNode
.DefaultConfigurationNode
and
initializes it with the node name.
Parameters: name the name of this node
DefaultConfigurationNode
and
initializes it with the name and a value.
Parameters: name the node's name value the node's value
Parameters: attr the attribute to be added
Parameters: child the new child
Returns: a copy of this object
SubNodes
instance that is used for storing
either this node's children or attributes.
Parameters: attributes true if the returned instance is used for storing attributes, false for storing child nodes
Returns: the SubNodes
object to use
Parameters: index the index (0-based)
Returns: the attribute with this index
Returns: the number of attributes
Parameters: name the name
Returns: the number of attributes with this name
ConfigurationNode
objects, too.
Returns: the attribute list, never null
Parameters: name the attribute's name
Returns: all attributes with this name
Parameters: index the index (0-based)
Returns: the child with this index
Returns: a list with all child nodes
Parameters: name the name; can be null , then all children are returned
Returns: a list of all children with the given name
Returns: the number of all children
Parameters: name the name; can be null , then the number of all children is returned
Returns: the number of child nodes with this name
Returns: the name of this node
Returns: the parent node or null if this is the root
Returns: the reference
Returns: the value of this node
Returns: a flag if this is an attribute node
Returns: a flag whether this node is defined
Parameters: node the attribute node to be removed
Returns: a flag if the attribute could be removed
Parameters: name the name
Returns: a flag if at least one attribute was removed
Parameters: child the node to be removed
Returns: a flag if a node was removed
Parameters: childName the name of the children to be removed
Returns: a flag if at least one child node was removed
Parameters: f the attribute flag
Parameters: name the new name
Parameters: parent the parent of this node
Parameters: reference the reference object
Parameters: val the value of this node
Parameters: visitor the visitor