Package org.apache.commons.configuration

Class PatternSubtreeConfigurationWrapper

    • Method Detail

      • addProperty

        public void addProperty​(java.lang.String key,
                        java.lang.Object value)
        Description copied from interface: Configuration
        Add a property to the configuration. If it already exists then the value stated here will be added to the configuration entry. For example, if the property: 
        resource.loader = file
        is already present in the configuration and you call 
        addProperty("resource.loader", "classpath")
        Then you will end up with a List like the following: 
        ["file", "classpath"]
        Specified by:
        addProperty in interface Configuration
        Overrides:
        addProperty in class AbstractConfiguration
        Parameters:
        key - The key to add the property to.
        value - The value to add.

      • containsKey

        public boolean containsKey​(java.lang.String key)
        Description copied from class: HierarchicalConfiguration
        Checks if the specified key is contained in this configuration. Note that for this configuration the term "contained" means that the key has an associated value. If there is a node for this key that has no value but children (either defined or undefined), this method will still return false .
        Specified by:
        containsKey in interface Configuration
        Overrides:
        containsKey in class AbstractHierarchicalFileConfiguration
        Parameters:
        key - the key to be chekced
        Returns:
        a flag if this key is contained in this configuration

      • getBigDecimal

        public java.math.BigDecimal getBigDecimal​(java.lang.String key,
                                          java.math.BigDecimal defaultValue)
        Description copied from interface: Configuration
        Get a BigDecimal associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.
        Specified by:
        getBigDecimal in interface Configuration
        Overrides:
        getBigDecimal in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        defaultValue - The default value.
        Returns:
        The associated BigDecimal if key is found and has valid format, default value otherwise.

      • getBigInteger

        public java.math.BigInteger getBigInteger​(java.lang.String key,
                                          java.math.BigInteger defaultValue)
        Description copied from interface: Configuration
        Get a BigInteger associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.
        Specified by:
        getBigInteger in interface Configuration
        Overrides:
        getBigInteger in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        defaultValue - The default value.
        Returns:
        The associated BigInteger if key is found and has valid format, default value otherwise.

      • getBoolean

        public java.lang.Boolean getBoolean​(java.lang.String key,
                                    java.lang.Boolean defaultValue)
        Description copied from class: AbstractConfiguration
        Obtains the value of the specified key and tries to convert it into a Boolean object. If the property has no value, the passed in default value will be used.
        Specified by:
        getBoolean in interface Configuration
        Overrides:
        getBoolean in class AbstractConfiguration
        Parameters:
        key - the key of the property
        defaultValue - the default value
        Returns:
        the value of this key converted to a Boolean
        See Also:
        PropertyConverter.toBoolean(Object)

      • getByte

        public byte getByte​(java.lang.String key,
                    byte defaultValue)
        Description copied from interface: Configuration
        Get a byte associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.
        Specified by:
        getByte in interface Configuration
        Overrides:
        getByte in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        defaultValue - The default value.
        Returns:
        The associated byte.

      • getByte

        public java.lang.Byte getByte​(java.lang.String key,
                              java.lang.Byte defaultValue)
        Description copied from interface: Configuration
        Get a Byte associated with the given configuration key.
        Specified by:
        getByte in interface Configuration
        Overrides:
        getByte in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        defaultValue - The default value.
        Returns:
        The associated byte if key is found and has valid format, default value otherwise.

      • getDouble

        public double getDouble​(java.lang.String key,
                        double defaultValue)
        Description copied from interface: Configuration
        Get a double associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.
        Specified by:
        getDouble in interface Configuration
        Overrides:
        getDouble in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        defaultValue - The default value.
        Returns:
        The associated double.

      • getDouble

        public java.lang.Double getDouble​(java.lang.String key,
                                  java.lang.Double defaultValue)
        Description copied from interface: Configuration
        Get a Double associated with the given configuration key.
        Specified by:
        getDouble in interface Configuration
        Overrides:
        getDouble in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        defaultValue - The default value.
        Returns:
        The associated double if key is found and has valid format, default value otherwise.

      • getFloat

        public float getFloat​(java.lang.String key,
                      float defaultValue)
        Description copied from interface: Configuration
        Get a float associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.
        Specified by:
        getFloat in interface Configuration
        Overrides:
        getFloat in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        defaultValue - The default value.
        Returns:
        The associated float.

      • getFloat

        public java.lang.Float getFloat​(java.lang.String key,
                                java.lang.Float defaultValue)
        Description copied from interface: Configuration
        Get a Float associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.
        Specified by:
        getFloat in interface Configuration
        Overrides:
        getFloat in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        defaultValue - The default value.
        Returns:
        The associated float if key is found and has valid format, default value otherwise.

      • getInt

        public int getInt​(java.lang.String key,
                  int defaultValue)
        Description copied from interface: Configuration
        Get a int associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.
        Specified by:
        getInt in interface Configuration
        Overrides:
        getInt in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        defaultValue - The default value.
        Returns:
        The associated int.

      • getInt

        public int getInt​(java.lang.String key)
        Description copied from interface: Configuration
        Get a int associated with the given configuration key.
        Specified by:
        getInt in interface Configuration
        Overrides:
        getInt in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        Returns:
        The associated int.

      • getInteger

        public java.lang.Integer getInteger​(java.lang.String key,
                                    java.lang.Integer defaultValue)
        Description copied from interface: Configuration
        Get an Integer associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.
        Specified by:
        getInteger in interface Configuration
        Overrides:
        getInteger in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        defaultValue - The default value.
        Returns:
        The associated int if key is found and has valid format, default value otherwise.

      • getKeys

        public java.util.Iterator<java.lang.String> getKeys()
        Description copied from class: HierarchicalConfiguration
        Returns an iterator with all keys defined in this configuration. Note that the keys returned by this method will not contain any indices. This means that some structure will be lost.

        Specified by:
        getKeys in interface Configuration
        Overrides:
        getKeys in class AbstractHierarchicalFileConfiguration
        Returns:
        an iterator with the defined keys in this configuration

      • getKeys

        public java.util.Iterator<java.lang.String> getKeys​(java.lang.String prefix)
        Description copied from class: HierarchicalConfiguration
        Returns an iterator with all keys defined in this configuration that start with the given prefix. The returned keys will not contain any indices. This implementation tries to locate a node whose key is the same as the passed in prefix. Then the subtree of this node is traversed, and the keys of all nodes encountered (including attributes) are added to the result set.
        Specified by:
        getKeys in interface Configuration
        Overrides:
        getKeys in class AbstractHierarchicalFileConfiguration
        Parameters:
        prefix - the prefix of the keys to start with
        Returns:
        an iterator with the found keys
        See Also:
        Configuration.getKeys()

      • getList

        public java.util.List<java.lang.Object> getList​(java.lang.String key,
                                                java.util.List<?> defaultValue)
        Description copied from interface: Configuration
        Get a List of strings associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.
        Specified by:
        getList in interface Configuration
        Overrides:
        getList in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        defaultValue - The default value.
        Returns:
        The associated List of strings.

      • getLong

        public long getLong​(java.lang.String key,
                    long defaultValue)
        Description copied from interface: Configuration
        Get a long associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.
        Specified by:
        getLong in interface Configuration
        Overrides:
        getLong in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        defaultValue - The default value.
        Returns:
        The associated long.

      • getLong

        public java.lang.Long getLong​(java.lang.String key,
                              java.lang.Long defaultValue)
        Description copied from interface: Configuration
        Get a Long associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.
        Specified by:
        getLong in interface Configuration
        Overrides:
        getLong in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        defaultValue - The default value.
        Returns:
        The associated long if key is found and has valid format, default value otherwise.

      • getProperties

        public java.util.Properties getProperties​(java.lang.String key)
        Description copied from interface: Configuration
        Get a list of properties associated with the given configuration key. This method expects the given key to have an arbitrary number of String values, each of which is of the form {code key=value}. These strings are split at the equals sign, and the key parts will become keys of the returned Properties object, the value parts become values.
        Specified by:
        getProperties in interface Configuration
        Overrides:
        getProperties in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        Returns:
        The associated properties if key is found.

      • getShort

        public short getShort​(java.lang.String key,
                      short defaultValue)
        Description copied from interface: Configuration
        Get a short associated with the given configuration key.
        Specified by:
        getShort in interface Configuration
        Overrides:
        getShort in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        defaultValue - The default value.
        Returns:
        The associated short.

      • getShort

        public java.lang.Short getShort​(java.lang.String key,
                                java.lang.Short defaultValue)
        Description copied from interface: Configuration
        Get a Short associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.
        Specified by:
        getShort in interface Configuration
        Overrides:
        getShort in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        defaultValue - The default value.
        Returns:
        The associated short if key is found and has valid format, default value otherwise.

      • getString

        public java.lang.String getString​(java.lang.String key,
                                  java.lang.String defaultValue)
        Description copied from interface: Configuration
        Get a string associated with the given configuration key. If the key doesn't map to an existing object, the default value is returned.
        Specified by:
        getString in interface Configuration
        Overrides:
        getString in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        defaultValue - The default value.
        Returns:
        The associated string if key is found and has valid format, default value otherwise.

      • getStringArray

        public java.lang.String[] getStringArray​(java.lang.String key)
        Description copied from class: AbstractConfiguration
        Get an array of strings associated with the given configuration key. If the key doesn't map to an existing object, an empty array is returned. If a property is added to a configuration, it is checked whether it contains multiple values. This is obvious if the added object is a list or an array. For strings it is checked whether the string contains the list delimiter character that can be specified using the setListDelimiter() method. If this is the case, the string is split at these positions resulting in a property with multiple values.
        Specified by:
        getStringArray in interface Configuration
        Overrides:
        getStringArray in class AbstractConfiguration
        Parameters:
        key - The configuration key.
        Returns:
        The associated string array if key is found.
        See Also:
        AbstractConfiguration.setListDelimiter(char), AbstractConfiguration.setDelimiterParsingDisabled(boolean)

      • subset

        public Configuration subset​(java.lang.String prefix)
        Description copied from class: HierarchicalConfiguration
        Creates a new Configuration object containing all keys that start with the specified prefix. This implementation will return a HierarchicalConfiguration object so that the structure of the keys will be saved. The nodes selected by the prefix (it is possible that multiple nodes are selected) are mapped to the root node of the returned configuration, i.e. their children and attributes will become children and attributes of the new root node. However a value of the root node is only set if exactly one of the selected nodes contain a value (if multiple nodes have a value, there is simply no way to decide how these values are merged together). Note that the returned Configuration object is not connected to its source configuration: updates on the source configuration are not reflected in the subset and vice versa.
        Specified by:
        subset in interface Configuration
        Overrides:
        subset in class HierarchicalConfiguration
        Parameters:
        prefix - the prefix of the keys for the subset
        Returns:
        a new configuration object representing the selected subset
        See Also:
        SubsetConfiguration

      • configurationAt

        public SubnodeConfiguration configurationAt​(java.lang.String key,
                                            boolean supportUpdates)
        Description copied from class: HierarchicalConfiguration

        Returns a hierarchical subnode configuration object that wraps the configuration node specified by the given key. This method provides an easy means of accessing sub trees of a hierarchical configuration. In the returned configuration the sub tree can directly be accessed, it becomes the root node of this configuration. Because of this the passed in key must select exactly one configuration node; otherwise an IllegalArgumentException will be thrown.

        The difference between this method and the HierarchicalConfiguration.subset(String) method is that subset() supports arbitrary subsets of configuration nodes while configurationAt() only returns a single sub tree. Please refer to the documentation of the SubnodeConfiguration class to obtain further information about subnode configurations and when they should be used.

        With the supportUpdate flag the behavior of the returned SubnodeConfiguration regarding updates of its parent configuration can be determined. A subnode configuration operates on the same nodes as its parent, so changes at one configuration are normally directly visible for the other configuration. There are however changes of the parent configuration, which are not recognized by the subnode configuration per default. An example for this is a reload operation (for file-based configurations): Here the complete node set of the parent configuration is replaced, but the subnode configuration still references the old nodes. If such changes should be detected by the subnode configuration, the supportUpdates flag must be set to true. This causes the subnode configuration to reevaluate the key used for its creation each time it is accessed. This guarantees that the subnode configuration always stays in sync with its key, even if the parent configuration's data significantly changes. If such a change makes the key invalid - because it now no longer points to exactly one node -, the subnode configuration is not reconstructed, but keeps its old data. It is then quasi detached from its parent.

        Overrides:
        configurationAt in class HierarchicalConfiguration
        Parameters:
        key - the key that selects the sub tree
        supportUpdates - a flag whether the returned subnode configuration should be able to handle updates of its parent
        Returns:
        a hierarchical configuration that contains this sub tree
        See Also:
        SubnodeConfiguration

      • configurationsAt

        public java.util.List<HierarchicalConfiguration> configurationsAt​(java.lang.String key)
        Description copied from class: HierarchicalConfiguration
        Returns a list of sub configurations for all configuration nodes selected by the given key. This method will evaluate the passed in key (using the current ExpressionEngine) and then create a subnode configuration for each returned node (like HierarchicalConfiguration.configurationAt(String)}). This is especially useful when dealing with list-like structures. As an example consider the configuration that contains data about database tables and their fields. If you need access to all fields of a certain table, you can simply do 
         List fields = config.configurationsAt("tables.table(0).fields.field");
 for(Iterator it = fields.iterator(); it.hasNext();)
 {
     HierarchicalConfiguration sub = (HierarchicalConfiguration) it.next();
     // now the children and attributes of the field node can be
     // directly accessed
     String fieldName = sub.getString("name");
     String fieldType = sub.getString("type");
     ...
        Overrides:
        configurationsAt in class HierarchicalConfiguration
        Parameters:
        key - the key for selecting the desired nodes
        Returns:
        a list with hierarchical configuration objects; each configuration represents one of the nodes selected by the passed in key

      • clearTree

        public void clearTree​(java.lang.String key)
        Description copied from class: HierarchicalConfiguration
        Removes all values of the property with the given name and of keys that start with this name. So if there is a property with the key "foo" and a property with the key "foo.bar", a call of clearTree("foo") would remove both properties.
        Overrides:
        clearTree in class AbstractHierarchicalFileConfiguration
        Parameters:
        key - the key of the property to be removed

      • getMaxIndex

        public int getMaxIndex​(java.lang.String key)
        Description copied from class: HierarchicalConfiguration
        Returns the maximum defined index for the given key. This is useful if there are multiple values for this key. They can then be addressed separately by specifying indices from 0 to the return value of this method.
        Overrides:
        getMaxIndex in class HierarchicalConfiguration
        Parameters:
        key - the key to be checked
        Returns:
        the maximum defined index for this key

      • interpolatedConfiguration

        public Configuration interpolatedConfiguration()
        Description copied from class: HierarchicalConfiguration
        Returns a configuration with the same content as this configuration, but with all variables replaced by their actual values. This implementation is specific for hierarchical configurations. It clones the current configuration and runs a specialized visitor on the clone, which performs interpolation on the single configuration nodes.
        Overrides:
        interpolatedConfiguration in class HierarchicalConfiguration
        Returns:
        a configuration with all variables interpolated

      • getConfigurationListeners

        public java.util.Collection<ConfigurationListener> getConfigurationListeners()
        Description copied from class: EventSource
        Returns a collection with all configuration event listeners that are currently registered at this object.
        Overrides:
        getConfigurationListeners in class EventSource
        Returns:
        a collection with the registered ConfigurationListeners (this collection is a snapshot of the currently registered listeners; manipulating it has no effect on this event source object)

      • getErrorListeners

        public java.util.Collection<ConfigurationErrorListener> getErrorListeners()
        Description copied from class: EventSource
        Returns a collection with all configuration error listeners that are currently registered at this object.
        Overrides:
        getErrorListeners in class EventSource
        Returns:
        a collection with the registered ConfigurationErrorListeners (this collection is a snapshot of the currently registered listeners; it cannot be manipulated)

      • resolveContainerStore

        protected java.lang.Object resolveContainerStore​(java.lang.String key)
        Description copied from class: AbstractConfiguration
        Returns an object from the store described by the key. If the value is a Collection object, replace it with the first object in the collection.
        Overrides:
        resolveContainerStore in class AbstractConfiguration
        Parameters:
        key - The property key.
        Returns:
        value Value, transparently resolving a possible collection dependency.