AbstractHierarchicalFileConfiguration (Commons Configuration 1.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.configuration
Class AbstractHierarchicalFileConfiguration

java.lang.Object
  org.apache.commons.configuration.event.EventSource
      org.apache.commons.configuration.AbstractConfiguration
          org.apache.commons.configuration.HierarchicalConfiguration
              org.apache.commons.configuration.AbstractHierarchicalFileConfiguration

All Implemented Interfaces:: Cloneable, Configuration, ConfigurationListener, FileConfiguration, Serializable

Direct Known Subclasses:: PropertyListConfiguration, XMLConfiguration, XMLPropertyListConfiguration

public abstract class AbstractHierarchicalFileConfiguration
extends HierarchicalConfiguration
implements FileConfiguration, ConfigurationListener

Base class for implementing file based hierarchical configurations.

This class serves an analogous purpose as the AbstractFileConfiguration class for non hierarchical configurations. It behaves in exactly the same way, so please refer to the documentation of AbstractFileConfiguration for further details.

Since:: 1.2
Version:: $Revision: 439648 $, $Date: 2006-09-02 22:42:10 +0200 (Sa, 02 Sep 2006) $
Author:: Emmanuel Bourg
See Also:: Serialized Form

Nested Class Summary
`protected class`	`AbstractHierarchicalFileConfiguration.FileConfigurationDelegate` A special implementation of the `FileConfiguration` interface that is used internally to implement the `FileConfiguration` methods for hierarchical configurations.

Nested classes inherited from class org.apache.commons.configuration.HierarchicalConfiguration

HierarchicalConfiguration.BuilderVisitor, HierarchicalConfiguration.CloneVisitor, HierarchicalConfiguration.DefinedKeysVisitor, HierarchicalConfiguration.DefinedVisitor, HierarchicalConfiguration.Node, HierarchicalConfiguration.NodeVisitor

Field Summary

Fields inherited from class org.apache.commons.configuration.HierarchicalConfiguration

EVENT_ADD_NODES, EVENT_CLEAR_TREE

Fields inherited from class org.apache.commons.configuration.AbstractConfiguration

END_TOKEN, EVENT_ADD_PROPERTY, EVENT_CLEAR, EVENT_CLEAR_PROPERTY, EVENT_SET_PROPERTY, START_TOKEN

Constructor Summary
`protected`	`AbstractHierarchicalFileConfiguration()`
	`AbstractHierarchicalFileConfiguration(File file)` Creates and loads the configuration from the specified file.
	`AbstractHierarchicalFileConfiguration(String fileName)` Creates and loads the configuration from the specified file.
	`AbstractHierarchicalFileConfiguration(URL url)` Creates and loads the configuration from the specified URL.

Method Summary
`protected void`	`addPropertyDirect(String key, Object obj)` Adds the property with the specified key.
`void`	`clearProperty(String key)` Remove a property from the configuration.
`void`	`clearTree(String key)` Removes all values of the property with the given name and of keys that start with this name.
`void`	`configurationChanged(ConfigurationEvent event)` Reacts on configuration change events triggered by the delegate.
`boolean`	`containsKey(String key)` Check if the configuration contains the specified key.
`protected AbstractHierarchicalFileConfiguration.FileConfigurationDelegate`	`createDelegate()` Creates the file configuration delegate, i.e. the object that implements functionality required by the `FileConfiguration` interface.
`String`	`getBasePath()` Return the base path.
`protected AbstractHierarchicalFileConfiguration.FileConfigurationDelegate`	`getDelegate()` Returns the file configuration delegate.
`String`	`getEncoding()` Return the encoding used to store the configuration file.
`File`	`getFile()` Return the file where the configuration is stored.
`String`	`getFileName()` Return the name of the file.
`Iterator`	`getKeys(String prefix)` Get the list of the keys contained in the configuration that match the specified prefix.
`Object`	`getProperty(String key)` Gets a property from the configuration.
`ReloadingStrategy`	`getReloadingStrategy()` Return the reloading strategy.
`URL`	`getURL()` Return the URL where the configuration is stored.
`boolean`	`isAutoSave()` Tells if properties are automatically saved to the disk.
`boolean`	`isEmpty()` Check if the configuration is empty.
`void`	`load()` Load the configuration from the underlying URL.
`void`	`load(File file)` Load the configuration from the specified file.
`void`	`load(InputStream in)` Load the configuration from the specified stream, using the encoding returned by `getEncoding()`.
`void`	`load(InputStream in, String encoding)` Load the configuration from the specified stream, using the specified encoding.
`void`	`load(String fileName)` Locate the specified file and load the configuration.
`void`	`load(URL url)` Load the configuration from the specified URL.
`void`	`reload()` Reload the configuration.
`void`	`save()` Save the configuration.
`void`	`save(File file)` Save the configuration to the specified file.
`void`	`save(OutputStream out)` Save the configuration to the specified stream, using the encoding returned by `getEncoding()`.
`void`	`save(OutputStream out, String encoding)` Save the configuration to the specified stream, using the specified encoding.
`void`	`save(String fileName)` Save the configuration to the specified file.
`void`	`save(URL url)` Save the configuration to the specified URL if it's a file URL.
`void`	`setAutoSave(boolean autoSave)` Enable or disable the automatical saving of modified properties to the disk.
`void`	`setBasePath(String basePath)` Set the base path.
`protected void`	`setDelegate(AbstractHierarchicalFileConfiguration.FileConfigurationDelegate delegate)` Allows to set the file configuration delegate.
`void`	`setEncoding(String encoding)` Set the encoding used to store the configuration file.
`void`	`setFile(File file)` Set the file where the configuration is stored.
`void`	`setFileName(String fileName)` Set the name of the file.
`void`	`setProperty(String key, Object value)` Set a property, this will replace any previously set values.
`void`	`setReloadingStrategy(ReloadingStrategy strategy)` Set the reloading strategy.
`void`	`setURL(URL url)` The URL where the configuration is stored.

Methods inherited from class org.apache.commons.configuration.HierarchicalConfiguration

addNodes, clearNode, clearNode, clone, configurationAt, configurationsAt, createAddPath, createNode, createSubnodeConfiguration, fetchAddNode, fetchNodeList, findLastPathNode, findPropertyNodes, getDefaultExpressionEngine, getExpressionEngine, getKeys, getMaxIndex, getRoot, getRootNode, nodeDefined, nodeDefined, removeNode, removeNode, setDefaultExpressionEngine, setExpressionEngine, setRoot, setRootNode, subset

Methods inherited from class org.apache.commons.configuration.AbstractConfiguration

addProperty, clear, clearPropertyDirect, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDefaultListDelimiter, getDelimiter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getList, getList, getListDelimiter, getLong, getLong, getLong, getProperties, getProperties, getShort, getShort, getShort, getString, getString, getStringArray, interpolate, interpolate, interpolateHelper, isDelimiterParsingDisabled, isThrowExceptionOnMissing, resolveContainerStore, setDefaultListDelimiter, setDelimiter, setDelimiterParsingDisabled, setListDelimiter, setThrowExceptionOnMissing

Methods inherited from class org.apache.commons.configuration.event.EventSource

addConfigurationListener, clearConfigurationListeners, createEvent, fireEvent, getConfigurationListeners, isDetailEvents, removeConfigurationListener, setDetailEvents

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.commons.configuration.FileConfiguration

load, save

Methods inherited from interface org.apache.commons.configuration.Configuration

addProperty, clear, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getKeys, getList, getList, getLong, getLong, getLong, getProperties, getShort, getShort, getShort, getString, getString, getStringArray, subset

Constructor Detail

AbstractHierarchicalFileConfiguration

protected AbstractHierarchicalFileConfiguration()

AbstractHierarchicalFileConfiguration

public AbstractHierarchicalFileConfiguration(String fileName)
                                      throws ConfigurationException

Creates and loads the configuration from the specified file.
Parameters:: fileName - The name of the plist file to load.
Throws:: ConfigurationException - Error while loading the file

AbstractHierarchicalFileConfiguration

public AbstractHierarchicalFileConfiguration(File file)
                                      throws ConfigurationException

Creates and loads the configuration from the specified file.
Parameters:: file - The configuration file to load.
Throws:: ConfigurationException - Error while loading the file

AbstractHierarchicalFileConfiguration

public AbstractHierarchicalFileConfiguration(URL url)
                                      throws ConfigurationException

Creates and loads the configuration from the specified URL.
Parameters:: url - The location of the configuration file to load.
Throws:: ConfigurationException - Error while loading the file

Method Detail

addPropertyDirect

protected void addPropertyDirect(String key,
                                 Object obj)

Description copied from class: HierarchicalConfiguration

Adds the property with the specified key. This task will be delegated to the associated ExpressionEngine, so the passed in key must match the requirements of this implementation.

Overrides:: addPropertyDirect in class HierarchicalConfiguration

Parameters:: key - the key of the new property; obj - the value of the new property

clearProperty

public void clearProperty(String key)

Description copied from interface: Configuration

Remove a property from the configuration.

Specified by:: clearProperty in interface Configuration
Overrides:: clearProperty in class HierarchicalConfiguration

Parameters:: key - the key of the property to be removed

clearTree

public void clearTree(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 HierarchicalConfiguration

Parameters:: key - the key of the property to be removed

setProperty

public void setProperty(String key,
                        Object value)

Description copied from interface: Configuration

Set a property, this will replace any previously set values. Set values is implicitly a call to clearProperty(key), addProperty(key, value).

Specified by:: setProperty in interface Configuration
Overrides:: setProperty in class HierarchicalConfiguration

Parameters:: key - the key of the property to set; value - the new value of this property