| Package | Description | 
|---|---|
| org.apache.commons.configuration2 | 
 
 The Configuration main package. 
 | 
| org.apache.commons.configuration2.tree | 
 
 A package with helper and utility classes used by hierarchical configurations. 
 | 
| org.apache.commons.configuration2.tree.xpath | 
 
 This package contains the  
XPathExpressionEngine class which
 enables XPATH support for querying configuration properties. | 
| Modifier and Type | Method and Description | 
|---|---|
String | 
AbstractHierarchicalConfiguration.nodeKey(T node,
       Map<T,String> cache,
       NodeHandler<T> handler)
Generates a unique key for the specified node. 
 | 
NodeAddData<T> | 
AbstractHierarchicalConfiguration.resolveAddKey(T root,
             String key,
             NodeHandler<T> handler)
Resolves a key of an add operation. 
 | 
List<QueryResult<T>> | 
AbstractHierarchicalConfiguration.resolveKey(T root,
          String key,
          NodeHandler<T> handler)
Performs a query for the specified key on the given root node. 
 | 
List<T> | 
AbstractHierarchicalConfiguration.resolveNodeKey(T root,
              String key,
              NodeHandler<T> handler)
Performs a query for the specified key on the given root node returning
 only node results. 
 | 
NodeUpdateData<T> | 
AbstractHierarchicalConfiguration.resolveUpdateKey(T root,
                String key,
                Object newValue,
                NodeHandler<T> handler)
Resolves a key for an update operation. 
 | 
void | 
BaseHierarchicalConfiguration.BuilderVisitor.visitBeforeChildren(ImmutableNode node,
                   NodeHandler<ImmutableNode> handler)  | 
| Modifier and Type | Interface and Description | 
|---|---|
interface  | 
ReferenceNodeHandler
 An extension of the  
NodeHandler interface which allows access to
 so-called references stored for a node. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
NodeHandlerDecorator<T>
 An abstract base class for decorators of a  
NodeHandler. | 
| Modifier and Type | Field and Description | 
|---|---|
protected static NodeHandler<ImmutableNode> | 
NodeCombiner.HANDLER
A default handler object for immutable nodes. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected abstract NodeHandler<T> | 
NodeHandlerDecorator.getDecoratedNodeHandler()
Returns the  
NodeHandler object that is decorated by this
 instance. | 
NodeHandler<ImmutableNode> | 
InMemoryNodeModel.getNodeHandler()
Returns a  
NodeHandler for dealing with the nodes managed by this
 model. | 
NodeHandler<ImmutableNode> | 
TrackedNodeModel.getNodeHandler()  | 
NodeHandler<T> | 
NodeModel.getNodeHandler()
Returns a  
NodeHandler for dealing with the nodes managed by this
 model. | 
NodeHandler<ImmutableNode> | 
InMemoryNodeModel.getTrackedNodeHandler(NodeSelector selector)
Returns a  
NodeHandler for a tracked node. | 
| Modifier and Type | Method and Description | 
|---|---|
<T> String | 
ExpressionEngine.canonicalKey(T node,
            String parentKey,
            NodeHandler<T> handler)
Determines a "canonical" key for the specified node in the
 expression language supported by this implementation. 
 | 
<T> String | 
DefaultExpressionEngine.canonicalKey(T node,
            String parentKey,
            NodeHandler<T> handler)
Determines a "canonical" key for the specified node in the
 expression language supported by this implementation. 
 | 
protected <T> T | 
DefaultExpressionEngine.findLastPathNode(DefaultConfigurationKey.KeyIterator keyIt,
                T node,
                NodeHandler<T> handler)
Finds the last existing node for an add operation. 
 | 
protected <T> void | 
DefaultExpressionEngine.findNodesForKey(DefaultConfigurationKey.KeyIterator keyPart,
               T node,
               Collection<QueryResult<T>> results,
               NodeHandler<T> handler)
Recursive helper method for evaluating a key. 
 | 
Object | 
QueryResult.getAttributeValue(NodeHandler<T> handler)
Returns the attribute value if this is an attribute result. 
 | 
<T> boolean | 
NodeMatcher.matches(T node,
       NodeHandler<T> handler,
       C criterion)
Tests whether the passed in node matches the given criterion. 
 | 
String | 
NodeKeyResolver.nodeKey(T node,
       Map<T,String> cache,
       NodeHandler<T> handler)
Generates a unique key for the specified node. 
 | 
<T> String | 
ExpressionEngine.nodeKey(T node,
       String parentKey,
       NodeHandler<T> handler)
Returns the key for the specified node in the expression language
 supported by an implementation. 
 | 
<T> String | 
DefaultExpressionEngine.nodeKey(T node,
       String parentKey,
       NodeHandler<T> handler)
Returns the key for the specified node in the expression language
 supported by an implementation. 
 | 
<T> NodeAddData<T> | 
ExpressionEngine.prepareAdd(T root,
          String key,
          NodeHandler<T> handler)
Returns information needed for an add operation. 
 | 
<T> NodeAddData<T> | 
DefaultExpressionEngine.prepareAdd(T root,
          String key,
          NodeHandler<T> handler)
 Prepares Adding the property with the specified key. 
 | 
<T> List<QueryResult<T>> | 
ExpressionEngine.query(T root,
     String key,
     NodeHandler<T> handler)
Finds the nodes and/or attributes that are matched by the specified key. 
 | 
<T> List<QueryResult<T>> | 
DefaultExpressionEngine.query(T root,
     String key,
     NodeHandler<T> handler)
Finds the nodes and/or attributes that are matched by the specified key. 
 | 
NodeAddData<T> | 
NodeKeyResolver.resolveAddKey(T root,
             String key,
             NodeHandler<T> handler)
Resolves a key of an add operation. 
 | 
List<QueryResult<T>> | 
NodeKeyResolver.resolveKey(T root,
          String key,
          NodeHandler<T> handler)
Performs a query for the specified key on the given root node. 
 | 
List<T> | 
NodeKeyResolver.resolveNodeKey(T root,
              String key,
              NodeHandler<T> handler)
Performs a query for the specified key on the given root node returning
 only node results. 
 | 
NodeUpdateData<T> | 
NodeKeyResolver.resolveUpdateKey(T root,
                String key,
                Object newValue,
                NodeHandler<T> handler)
Resolves a key for an update operation. 
 | 
ImmutableNode | 
NodeSelector.select(ImmutableNode root,
      NodeKeyResolver<ImmutableNode> resolver,
      NodeHandler<ImmutableNode> handler)
Applies this  
NodeSelector on the specified root node. | 
void | 
ConfigurationNodeVisitor.visitAfterChildren(T node,
                  NodeHandler<T> handler)
Visits the specified node after after its children - if existing - have
 been processed. 
 | 
void | 
ConfigurationNodeVisitorAdapter.visitAfterChildren(T node,
                  NodeHandler<T> handler)
Visits the specified node after after its children - if existing - have
 been processed. 
 | 
void | 
ConfigurationNodeVisitor.visitBeforeChildren(T node,
                   NodeHandler<T> handler)
Visits the specified node before the children of this node - if existing
 - are processed. 
 | 
void | 
ConfigurationNodeVisitorAdapter.visitBeforeChildren(T node,
                   NodeHandler<T> handler)
Visits the specified node before the children of this node - if existing
 - are processed. 
 | 
<T> void | 
NodeTreeWalker.walkBFS(T root,
       ConfigurationNodeVisitor<T> visitor,
       NodeHandler<T> handler)
Visits all nodes in the hierarchy represented by the given root node in
 breadth first search manner. 
 | 
<T> void | 
NodeTreeWalker.walkDFS(T root,
       ConfigurationNodeVisitor<T> visitor,
       NodeHandler<T> handler)
Visits all nodes in the hierarchy represented by the given root node in
 depth first search manner. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
<T> String | 
XPathExpressionEngine.canonicalKey(T node,
            String parentKey,
            NodeHandler<T> handler)
Determines a "canonical" key for the specified node in the
 expression language supported by this implementation. 
 | 
<T> String | 
XPathExpressionEngine.nodeKey(T node,
       String parentKey,
       NodeHandler<T> handler)
Returns the key for the specified node in the expression language
 supported by an implementation. 
 | 
<T> NodeAddData<T> | 
XPathExpressionEngine.prepareAdd(T root,
          String key,
          NodeHandler<T> handler)
Returns information needed for an add operation. 
 | 
<T> List<QueryResult<T>> | 
XPathExpressionEngine.query(T root,
     String key,
     NodeHandler<T> handler)
Finds the nodes and/or attributes that are matched by the specified key. 
 | 
static <T> Object | 
ConfigurationNodePointerFactory.wrapNode(T node,
        NodeHandler<T> handler)
Creates a node wrapper for the specified node and its handler. 
 | 
Copyright © 2001–2020 The Apache Software Foundation. All rights reserved.