DdlConfigNode (Rumi 4.0.595 API)

java.lang.Object
- com.neeve.ddl.DdlConfigNode

All Implemented Interfaces:

Comparable<DdlConfigNode>

Direct Known Subclasses:

DdlConfigTree
```
public class DdlConfigNode
extends Object
implements Comparable<DdlConfigNode>
```
A DDL config node.

Threading:

this class and its methods are not safe for concurrent access.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DdlConfigNode`	`add(String key, String value)` Adds a descendent value into the tree.
`void`	`addAll(Properties properties)` Adds all of the properties as child properties.
`DdlConfigNode`	`addNode(String relativePath, DdlConfigNode node)` Grafts the provide config node at the relative path specified by the key.
`Collection<DdlConfigNode>`	`collectDescendents(Collection<DdlConfigNode> collection)` Collects all of the descendences of this node.
`int`	`compareTo(DdlConfigNode o)`
`boolean`	`equals(Object other)`
`DdlConfigNode`	`get(String relativePath)` Gets a child node at a path relative to this node.
`Collection<DdlConfigNode>`	`getChildren()` Gets this nodes child nodes.
`String`	`getFullName()` Gets the ful name of the node (including ancenstor levels).
`String`	`getName()` Gets the short name of this node.
`DdlConfigNode`	`getParent()` Gets this node's immediate parent node..
`DdlConfigNode`	`getRequiredChild(String name)` Gets a required child node.
`String`	`getRequiredValue()` Gets the value of this node, ensuring that a value exists.
`String`	`getRequiredValue(String name)` Gets a required value of a child of this node by name.
`DdlConfigTree`	`getRoot()` Gets this node's config tree root.
`String`	`getUnsubstitutedValue()` Returns the value of the node without doing substitutions.
`String`	`getValue()` Gets the value of this node.
`String`	`getValue(String name)` Gets the value of a child if it exists.
`boolean`	`getValue(String name, boolean defaultValue)` Fetch the value of the given child node as a boolean.
`short`	`getValue(String name, byte defaultValue)` Fetch the value of the given child node as a byte.
`char`	`getValue(String name, char defaultValue)` Fetch the value of the given child node as a char.
`double`	`getValue(String name, double defaultValue)` Fetch the value of the given child node as a float.
`float`	`getValue(String name, float defaultValue)` Fetch the value of the given child node as a float.
`int`	`getValue(String name, int defaultValue)` Fetch the value of the given child node as a int.
`long`	`getValue(String name, long defaultValue)` Fetch the value of the given child node as a long.
`short`	`getValue(String name, short defaultValue)` Fetch the value of the given child node as a short.
`String`	`getValue(String name, String defaultValue)` Gets the value of a child if it exists.
`int`	`hashCode()`
`void`	`merge(DdlConfigNode source, boolean override)` Merges source values into this node.
`DdlConfigNode`	`remove(String relativePath)` Removes a child (and all of its descendants from the tree.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getName
```
public final String getName()
```
    Gets the short name of this node.
    
    Returns:
    
    The name of this node without its ancestor prefix.
  - getFullName
```
public final String getFullName()
```
    Gets the ful name of the node (including ancenstor levels).
    
    Returns:
    
    The full node name.
  - getUnsubstitutedValue
```
public final String getUnsubstitutedValue()
```
    Returns the value of the node without doing substitutions.
    
    Returns:
    
    The unsubstituted value of the node.
  - getValue
```
public final String getValue()
```
    Gets the value of this node.
    
    Returns:
    
    The value of this node or null if it has no value.
  - getValue
```
public boolean getValue(String name,
                        boolean defaultValue)
```
    Fetch the value of the given child node as a boolean.
    
    Parameters:
    
    name - the child node name (relative to this node).
    
    defaultValue - The default value if the node doesn't exist or is not set.
    
    Returns:
    
    The child node value.
  - getValue
```
public short getValue(String name,
                      byte defaultValue)
```
    Fetch the value of the given child node as a byte.
    
    Parameters:
    
    name - the child node name (relative to this node).
    
    defaultValue - The default value if the node doesn't exist or is not set.
    
    Returns:
    
    The child node value.
  - getValue
```
public char getValue(String name,
                     char defaultValue)
```
    Fetch the value of the given child node as a char.
    
    Parameters:
    
    name - the child node name (relative to this node).
    
    defaultValue - The default value if the node doesn't exist or is not set.
    
    Returns:
    
    The child node value.
  - getValue
```
public short getValue(String name,
                      short defaultValue)
```
    Fetch the value of the given child node as a short.
    
    Parameters:
    
    name - the child node name (relative to this node).
    
    defaultValue - The default value if the node doesn't exist or is not set.
    
    Returns:
    
    The child node value.
  - getValue
```
public int getValue(String name,
                    int defaultValue)
```
    Fetch the value of the given child node as a int.
    
    Parameters:
    
    name - the child node name (relative to this node).
    
    defaultValue - The default value if the node doesn't exist or is not set.
    
    Returns:
    
    The child node value.
  - getValue
```
public long getValue(String name,
                     long defaultValue)
```
    Fetch the value of the given child node as a long.
    
    Parameters:
    
    name - the child node name (relative to this node).
    
    defaultValue - The default value if the node doesn't exist or is not set.
    
    Returns:
    
    The child node value.
  - getValue
```
public float getValue(String name,
                      float defaultValue)
```
    Fetch the value of the given child node as a float.
    
    Parameters:
    
    name - the child node name (relative to this node).
    
    defaultValue - The default value if the node doesn't exist or is not set.
    
    Returns:
    
    The child node value.
  - getValue
```
public double getValue(String name,
                       double defaultValue)
```
    Fetch the value of the given child node as a float.
    
    Parameters:
    
    name - the child node name (relative to this node).
    
    defaultValue - The default value if the node doesn't exist or is not set.
    
    Returns:
    
    The child node value.
  - get
```
public DdlConfigNode get(String relativePath)
```
    Gets a child node at a path relative to this node.
    
    Parameters:
    
    relativePath - The child path relative to this node.
  - getValue
```
public final String getValue(String name)
```
    Gets the value of a child if it exists.
    
    Parameters:
    
    name - the child node name (relative to this node).
    
    Returns:
    
    The value of the child node if it exists or null.
  - getValue
```
public final String getValue(String name,
                             String defaultValue)
```
    Gets the value of a child if it exists.
    
    Parameters:
    
    name - the child node name (relative to this node).
    
    defaultValue - The default value if the node doesn't exist or is not set.
    
    Returns:
    
    The value of the child node if it exists or null.
  - getRequiredValue
```
public String getRequiredValue()
```
    Gets the value of this node, ensuring that a value exists.
    
    Returns:
    
    The value for this node.
  - getRequiredValue
```
public String getRequiredValue(String name)
```
    Gets a required value of a child of this node by name.
    
    Returns:
    
    The value for this node (relative to this node).
    
    Throws:
    
    DdlConfigException - if the value cannot be found.
  - getRoot
```
public DdlConfigTree getRoot()
```
    Gets this node's config tree root.
    
    Returns:
    
    This node's config tree root (or null if not attached to a config tree)
  - getParent
```
public DdlConfigNode getParent()
```
    Gets this node's immediate parent node..
    
    Returns:
    
    This node's immediate parent node.
  - getChildren
```
public Collection<DdlConfigNode> getChildren()
```
    Gets this nodes child nodes.
    
    Returns:
    
    This node's immediate child nodes.
  - getRequiredChild
```
public DdlConfigNode getRequiredChild(String name)
```
    Gets a required child node.
    
    Parameters:
    
    name - The child node name.
    
    Throws:
    
    DdlConfigException - if the property is not found.
  - addAll
```
public void addAll(Properties properties)
```
    Adds all of the properties as child properties.
    
    Parameters:
    
    properties - The properties to add.
  - merge
```
public void merge(DdlConfigNode source,
                  boolean override)
```
    Merges source values into this node.
    
    Parameters:
    
    source - The source node.
    
    override - Whether or not to override existing values with the source values.
  - add
```
public DdlConfigNode add(String key,
                         String value)
```
    Adds a descendent value into the tree.
    
    Parameters:
    
    key - (relative to this DdlConfigNode).
    
    value - The value or null if the node doesn't hold a value.
    
    Returns:
    
    The added node.
  - remove
```
public DdlConfigNode remove(String relativePath)
```
    Removes a child (and all of its descendants from the tree.
    This operation leaves the tree beneath the removed node intact relative to the node removed, but detached from the config tree to which the node formerlly belonged.
    
    Parameters:
    
    relativePath - The path to the node to remove relative to this DdlConfigNode.
    
    Returns:
    
    The node that was removed.
  - addNode
```
public DdlConfigNode addNode(String relativePath,
                             DdlConfigNode node)
```
    Grafts the provide config node at the relative path specified by the key.
    If the node already has a parent it will be removed from the parent and relocated to the relative path specified by the provided key.
    This method will create any intermediate config nodes that do not exist.
    
    Parameters:
    
    relativePath - The path, relative to this DdlConfigNode.
    
    node - The node to add.
    
    Returns:
    
    The the node that was replaced or null if no node was replaced.
  - collectDescendents
```
public Collection<DdlConfigNode> collectDescendents(Collection<DdlConfigNode> collection)
```
    Collects all of the descendences of this node.
    
    Parameters:
    
    collection - The collection to which to add this node's descendents.
    
    Returns:
    
    the passed in collection.
  - compareTo
```
public int compareTo(DdlConfigNode o)
```
    Specified by:
    
    compareTo in interface Comparable<DdlConfigNode>
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DdlConfigNode

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getFullName

getUnsubstitutedValue

getValue

getValue

getValue

getValue

getValue

getValue

getValue

getValue

getValue

get

getValue

getValue

getRequiredValue

getRequiredValue

getRoot

getParent

getChildren

getRequiredChild

addAll

merge

add

remove

addNode

collectDescendents

compareTo

equals

hashCode

toString