| Package | Description |
|---|---|
| org.apache.commons.configuration |
The Configuration main package.
|
| org.apache.commons.configuration.beanutils |
In this package a
Configuration implementation can be found that
implements the DynaBean interface. |
| org.apache.commons.configuration.plist |
Configuration classes supporting NeXT / OpenStep /GNUStep style configuration.
|
| org.apache.commons.configuration.tree |
A package with helper and utility classes used by hierarchical configurations.
|
| org.apache.commons.configuration.tree.xpath |
This package contains the implementation of the XPathExpressionEngine class, which
enables XPATH support for querying configuration properties.
|
| Modifier and Type | Class and Description |
|---|---|
static class |
HierarchicalConfiguration.Node
A data class for storing (hierarchical) property information.
|
| Modifier and Type | Method and Description |
|---|---|
ConfigurationNode |
SubnodeConfiguration.getRootNode()
Returns the root node for this configuration.
|
ConfigurationNode |
PatternSubtreeConfigurationWrapper.getRootNode() |
ConfigurationNode |
MultiFileHierarchicalConfiguration.getRootNode() |
ConfigurationNode |
HierarchicalConfiguration.getRootNode()
Returns the root node of this hierarchical configuration.
|
ConfigurationNode |
DynamicCombinedConfiguration.getRootNode()
Returns the configuration root node of this combined configuration.
|
ConfigurationNode |
CombinedConfiguration.getRootNode()
Returns the configuration root node of this combined configuration.
|
| Modifier and Type | Method and Description |
|---|---|
protected List<ConfigurationNode> |
HierarchicalConfiguration.fetchNodeList(String key)
Helper method for fetching a list of all nodes that are addressed by the
specified key.
|
protected List<ConfigurationNode> |
CombinedConfiguration.fetchNodeList(String key)
Evaluates the passed in property key and returns a list with the matching
configuration nodes.
|
protected List<ConfigurationNode> |
AbstractHierarchicalFileConfiguration.fetchNodeList(String key)
Fetches a list of nodes, which are selected by the specified key.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
HierarchicalConfiguration.clearNode(ConfigurationNode node)
Clears the value of the specified node.
|
protected static void |
HierarchicalConfiguration.clearReferences(ConfigurationNode node)
Clears all reference fields in a node structure.
|
protected SubnodeConfiguration |
SubnodeConfiguration.createSubnodeConfiguration(ConfigurationNode node)
Returns a hierarchical configuration object for the given sub node.
|
protected SubnodeConfiguration |
HierarchicalConfiguration.createSubnodeConfiguration(ConfigurationNode node)
Creates a subnode configuration for the specified node.
|
protected SubnodeConfiguration |
SubnodeConfiguration.createSubnodeConfiguration(ConfigurationNode node,
String subnodeKey)
Returns a hierarchical configuration object for the given sub node that
is aware of structural changes of its parent.
|
protected SubnodeConfiguration |
HierarchicalConfiguration.createSubnodeConfiguration(ConfigurationNode node,
String subnodeKey)
Creates a new subnode configuration for the specified node and sets its
construction key.
|
protected boolean |
DefaultConfigurationBuilder.ConfigurationDeclaration.isReservedNode(ConfigurationNode nd)
Checks whether the given node is reserved.
|
protected boolean |
HierarchicalConfiguration.nodeDefined(ConfigurationNode node)
Checks if the specified node is defined.
|
protected void |
HierarchicalConfiguration.removeNode(ConfigurationNode node)
Removes the specified node from this configuration.
|
void |
PatternSubtreeConfigurationWrapper.setRootNode(ConfigurationNode rootNode) |
void |
MultiFileHierarchicalConfiguration.setRootNode(ConfigurationNode rootNode) |
void |
HierarchicalConfiguration.setRootNode(ConfigurationNode rootNode)
Sets the root node of this hierarchical configuration.
|
void |
DynamicCombinedConfiguration.setRootNode(ConfigurationNode rootNode) |
| Modifier and Type | Method and Description |
|---|---|
void |
XMLConfiguration.addNodes(String key,
Collection<? extends ConfigurationNode> nodes)
Adds a collection of nodes directly to this configuration.
|
void |
PatternSubtreeConfigurationWrapper.addNodes(String key,
Collection<? extends ConfigurationNode> nodes) |
void |
MultiFileHierarchicalConfiguration.addNodes(String key,
Collection<? extends ConfigurationNode> nodes) |
void |
HierarchicalConfiguration.addNodes(String key,
Collection<? extends ConfigurationNode> nodes)
Adds a collection of nodes at the specified position of the configuration
tree.
|
void |
DynamicCombinedConfiguration.addNodes(String key,
Collection<? extends ConfigurationNode> nodes) |
void |
AbstractHierarchicalFileConfiguration.addNodes(String key,
Collection<? extends ConfigurationNode> nodes)
Directly adds sub nodes to this configuration.
|
protected void |
HierarchicalConfiguration.findPropertyNodes(ConfigurationKey.KeyIterator keyPart,
HierarchicalConfiguration.Node node,
Collection<ConfigurationNode> nodes)
Deprecated.
Property keys are now evaluated by the expression engine
associated with the configuration; this method will no longer be called.
If you want to modify the way properties are looked up, consider
implementing you own
ExpressionEngine implementation. |
| Constructor and Description |
|---|
HierarchicalConfiguration.Node(ConfigurationNode src)
Creates a new instance of
Node based on the given
source node. |
SubnodeConfiguration(HierarchicalConfiguration parent,
ConfigurationNode root)
Creates a new instance of
SubnodeConfiguration and
initializes it with the parent configuration and the new root node. |
| Modifier and Type | Method and Description |
|---|---|
ConfigurationNode |
XMLBeanDeclaration.getNode()
Returns the node that contains the bean declaration.
|
| Modifier and Type | Method and Description |
|---|---|
protected BeanDeclaration |
XMLBeanDeclaration.createBeanDeclaration(ConfigurationNode node)
Creates a new
BeanDeclaration for a child node of the
current configuration node. |
protected boolean |
XMLBeanDeclaration.isReservedNode(ConfigurationNode nd)
Checks if the specified node is reserved and thus should be ignored.
|
| Constructor and Description |
|---|
XMLBeanDeclaration(SubnodeConfiguration config,
ConfigurationNode node)
Creates a new instance of
XMLBeanDeclaration and
initializes it with the configuration node that contains the bean
declaration. |
| Modifier and Type | Class and Description |
|---|---|
static class |
XMLPropertyListConfiguration.ArrayNode
Container for array elements.
|
static class |
XMLPropertyListConfiguration.PListNode
Node extension with addXXX methods to parse the typed data passed by the SAX handler.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultConfigurationNode
A default implementation of the
ConfigurationNode interface. |
class |
ViewNode
A specialized node implementation to be used in view configurations.
|
| Modifier and Type | Method and Description |
|---|---|
protected ConfigurationNode |
OverrideCombiner.canCombine(ConfigurationNode node1,
ConfigurationNode node2,
ConfigurationNode child)
Tests if a child node of the second node can be combined with the given
child node of the first node.
|
protected ConfigurationNode |
MergeCombiner.canCombine(ConfigurationNode node1,
ConfigurationNode node2,
ConfigurationNode child,
List<ConfigurationNode> children2)
Tests if the first node can be combined with the second node.
|
ConfigurationNode |
UnionCombiner.combine(ConfigurationNode node1,
ConfigurationNode node2)
Combines the given nodes to a new union node.
|
ConfigurationNode |
OverrideCombiner.combine(ConfigurationNode node1,
ConfigurationNode node2)
Constructs an override combination for the passed in node structures.
|
abstract ConfigurationNode |
NodeCombiner.combine(ConfigurationNode node1,
ConfigurationNode node2)
Combines the hierarchies represented by the given root nodes.
|
ConfigurationNode |
MergeCombiner.combine(ConfigurationNode node1,
ConfigurationNode node2)
Combines the given nodes to a new union node.
|
protected ConfigurationNode |
UnionCombiner.findCombineNode(ConfigurationNode node1,
ConfigurationNode node2,
ConfigurationNode child,
List<ConfigurationNode> children)
Tries to find a child node of the second source node, with which a child
of the first source node can be combined.
|
protected ConfigurationNode |
DefaultExpressionEngine.findLastPathNode(DefaultConfigurationKey.KeyIterator keyIt,
ConfigurationNode node)
Finds the last existing node for an add operation.
|
ConfigurationNode |
DefaultConfigurationNode.getAttribute(int index)
Returns the attribute with the given index.
|
ConfigurationNode |
ConfigurationNode.getAttribute(int index)
Returns the attribute node with the given index.
|
ConfigurationNode |
DefaultConfigurationNode.getChild(int index)
Returns the child node with the given index.
|
ConfigurationNode |
ConfigurationNode.getChild(int index)
Returns the child node with the given index.
|
ConfigurationNode |
DefaultConfigurationNode.SubNodes.getNode(int index)
Returns the node with the given index.
|
ConfigurationNode |
NodeAddData.getParent()
Returns the parent node.
|
ConfigurationNode |
DefaultConfigurationNode.getParentNode()
Returns a reference to this node's parent.
|
ConfigurationNode |
ConfigurationNode.getParentNode()
Returns this node's parent.
|
| Modifier and Type | Method and Description |
|---|---|
List<ConfigurationNode> |
DefaultConfigurationNode.getAttributes()
Returns a list with the attributes of this node.
|
List<ConfigurationNode> |
ConfigurationNode.getAttributes()
Returns a list with this node's attributes.
|
List<ConfigurationNode> |
DefaultConfigurationNode.getAttributes(String name)
Returns a list with all attributes of this node with the given name.
|
List<ConfigurationNode> |
ConfigurationNode.getAttributes(String name)
Returns a list with the attribute nodes with the given name.
|
List<ConfigurationNode> |
DefaultConfigurationNode.getChildren()
Returns a list with all children of this node.
|
List<ConfigurationNode> |
ConfigurationNode.getChildren()
Returns a list with the child nodes of this node.
|
List<ConfigurationNode> |
DefaultConfigurationNode.getChildren(String name)
Returns a list of all children with the given name.
|
List<ConfigurationNode> |
ConfigurationNode.getChildren(String name)
Returns a list with all children of this node with the given name.
|
List<ConfigurationNode> |
DefaultConfigurationNode.SubNodes.getSubNodes()
Returns a list with all stored sub nodes.
|
List<ConfigurationNode> |
DefaultConfigurationNode.SubNodes.getSubNodes(String name)
Returns a list of the sub nodes with the given name.
|
List<ConfigurationNode> |
ExpressionEngine.query(ConfigurationNode root,
String key)
Finds the node(s) that is (are) matched by the specified key.
|
List<ConfigurationNode> |
DefaultExpressionEngine.query(ConfigurationNode root,
String key)
Evaluates the given key and returns all matching nodes.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ViewNode.addAttribute(ConfigurationNode attr)
Adds an attribute to this view node.
|
void |
DefaultConfigurationNode.addAttribute(ConfigurationNode attr)
Adds the specified attribute to this node.
|
void |
ConfigurationNode.addAttribute(ConfigurationNode attr)
Adds the specified attribute to this node
|
protected void |
OverrideCombiner.addAttributes(ViewNode result,
ConfigurationNode node1,
ConfigurationNode node2)
Handles the attributes during a combination process.
|
protected void |
MergeCombiner.addAttributes(ViewNode result,
ConfigurationNode node1,
ConfigurationNode node2)
Handles the attributes during a combination process.
|
void |
ViewNode.addChild(ConfigurationNode child)
Adds a child node to this view node.
|
void |
DefaultConfigurationNode.addChild(ConfigurationNode child)
Adds a new child to this node.
|
void |
ConfigurationNode.addChild(ConfigurationNode node)
Adds a child to this node.
|
void |
DefaultConfigurationNode.SubNodes.addNode(ConfigurationNode node)
Adds a new sub node.
|
void |
ViewNode.appendAttributes(ConfigurationNode source)
Adds all attribute nodes of the given source node to this view node.
|
void |
ViewNode.appendChildren(ConfigurationNode source)
Adds all child nodes of the given source node to this view node.
|
protected ConfigurationNode |
OverrideCombiner.canCombine(ConfigurationNode node1,
ConfigurationNode node2,
ConfigurationNode child)
Tests if a child node of the second node can be combined with the given
child node of the first node.
|
protected ConfigurationNode |
MergeCombiner.canCombine(ConfigurationNode node1,
ConfigurationNode node2,
ConfigurationNode child,
List<ConfigurationNode> children2)
Tests if the first node can be combined with the second node.
|
ConfigurationNode |
UnionCombiner.combine(ConfigurationNode node1,
ConfigurationNode node2)
Combines the given nodes to a new union node.
|
ConfigurationNode |
OverrideCombiner.combine(ConfigurationNode node1,
ConfigurationNode node2)
Constructs an override combination for the passed in node structures.
|
abstract ConfigurationNode |
NodeCombiner.combine(ConfigurationNode node1,
ConfigurationNode node2)
Combines the hierarchies represented by the given root nodes.
|
ConfigurationNode |
MergeCombiner.combine(ConfigurationNode node1,
ConfigurationNode node2)
Combines the given nodes to a new union node.
|
protected void |
DefaultConfigurationNode.SubNodes.detachNode(ConfigurationNode subNode)
This method is called whenever a sub node is removed from this
object.
|
protected ConfigurationNode |
UnionCombiner.findCombineNode(ConfigurationNode node1,
ConfigurationNode node2,
ConfigurationNode child,
List<ConfigurationNode> children)
Tries to find a child node of the second source node, with which a child
of the first source node can be combined.
|
protected ConfigurationNode |
DefaultExpressionEngine.findLastPathNode(DefaultConfigurationKey.KeyIterator keyIt,
ConfigurationNode node)
Finds the last existing node for an add operation.
|
protected void |
DefaultExpressionEngine.findNodesForKey(DefaultConfigurationKey.KeyIterator keyPart,
ConfigurationNode node,
Collection<ConfigurationNode> nodes)
Recursive helper method for evaluating a key.
|
boolean |
NodeCombiner.isListNode(ConfigurationNode node)
Checks if a node is a list node.
|
String |
ExpressionEngine.nodeKey(ConfigurationNode node,
String parentKey)
Returns the key for the specified node in the expression language
supported by an implementation.
|
String |
DefaultExpressionEngine.nodeKey(ConfigurationNode node,
String parentKey)
Determines the key of the passed in node.
|
NodeAddData |
ExpressionEngine.prepareAdd(ConfigurationNode root,
String key)
Returns information needed for an add operation.
|
NodeAddData |
DefaultExpressionEngine.prepareAdd(ConfigurationNode root,
String key)
Prepares Adding the property with the specified key.
|
static void |
TreeUtils.printTree(PrintStream stream,
ConfigurationNode result)
Print out the data in the configuration.
|
List<ConfigurationNode> |
ExpressionEngine.query(ConfigurationNode root,
String key)
Finds the node(s) that is (are) matched by the specified key.
|
List<ConfigurationNode> |
DefaultExpressionEngine.query(ConfigurationNode root,
String key)
Evaluates the given key and returns all matching nodes.
|
boolean |
DefaultConfigurationNode.removeAttribute(ConfigurationNode node)
Removes the specified attribute.
|
boolean |
ConfigurationNode.removeAttribute(ConfigurationNode node)
Removes the specified attribute from this node.
|
boolean |
DefaultConfigurationNode.removeChild(ConfigurationNode child)
Removes the specified child node from this node.
|
boolean |
ConfigurationNode.removeChild(ConfigurationNode child)
Removes the given node from this node's children.
|
boolean |
DefaultConfigurationNode.SubNodes.removeNode(ConfigurationNode node)
Removes a sub node.
|
void |
NodeAddData.setParent(ConfigurationNode parent)
Sets the parent node.
|
void |
DefaultConfigurationNode.setParentNode(ConfigurationNode parent)
Sets the parent of this node.
|
void |
ConfigurationNode.setParentNode(ConfigurationNode parent)
Sets the parent of this node.
|
void |
ConfigurationNodeVisitorAdapter.visitAfterChildren(ConfigurationNode node)
Empty dummy implementation of this interface method.
|
void |
ConfigurationNodeVisitor.visitAfterChildren(ConfigurationNode node)
Visits the specified node.
|
void |
ConfigurationNodeVisitorAdapter.visitBeforeChildren(ConfigurationNode node)
Empty dummy implementation of this interface method.
|
void |
ConfigurationNodeVisitor.visitBeforeChildren(ConfigurationNode node)
Visits the specified node.
|
| Modifier and Type | Method and Description |
|---|---|
protected ConfigurationNode |
MergeCombiner.canCombine(ConfigurationNode node1,
ConfigurationNode node2,
ConfigurationNode child,
List<ConfigurationNode> children2)
Tests if the first node can be combined with the second node.
|
protected void |
DefaultConfigurationNode.SubNodes.detachNodes(Collection<? extends ConfigurationNode> subNodes)
Detaches a list of sub nodes.
|
protected ConfigurationNode |
UnionCombiner.findCombineNode(ConfigurationNode node1,
ConfigurationNode node2,
ConfigurationNode child,
List<ConfigurationNode> children)
Tries to find a child node of the second source node, with which a child
of the first source node can be combined.
|
protected void |
DefaultExpressionEngine.findNodesForKey(DefaultConfigurationKey.KeyIterator keyPart,
ConfigurationNode node,
Collection<ConfigurationNode> nodes)
Recursive helper method for evaluating a key.
|
| Constructor and Description |
|---|
NodeAddData(ConfigurationNode parent,
String nodeName)
Creates a new instance of
NodeAddData and sets the most
important data fields. |
| Modifier and Type | Method and Description |
|---|---|
List<ConfigurationNode> |
XPathExpressionEngine.query(ConfigurationNode root,
String key)
Executes a query.
|
| Modifier and Type | Method and Description |
|---|---|
protected org.apache.commons.jxpath.JXPathContext |
XPathExpressionEngine.createContext(ConfigurationNode root,
String key)
Creates the
JXPathContext used for executing a query. |
String |
XPathExpressionEngine.nodeKey(ConfigurationNode node,
String parentKey)
Returns a (canonical) key for the given node based on the parent's key.
|
NodeAddData |
XPathExpressionEngine.prepareAdd(ConfigurationNode root,
String key)
Prepares an add operation for a configuration property.
|
List<ConfigurationNode> |
XPathExpressionEngine.query(ConfigurationNode root,
String key)
Executes a query.
|
Copyright © 2001–2013 The Apache Software Foundation. All rights reserved.