org.settings4j.settings

Class DefaultSettingsRepository

java.lang.Object

org.settings4j.settings.DefaultSettingsRepository

All Implemented Interfaces:

Settings4jRepository

public class DefaultSettingsRepository
extends Object
implements Settings4jRepository

This class is specialized in retrieving settings by name and also maintaining the settings hierarchy.

The casual user does not have to deal with this class directly.

The structure of the settings hierarchy is maintained by the getSettings() method. The hierarchy is such that children link to their parent but parents do not have any pointers to their children. Moreover, settings can be instantiated in any order, in particular descendant before ancestor.

In case a descendant is created before a particular ancestor, then it creates a provision node for the ancestor and adds itself to the provision node. Other descendants of the same ancestor add themselves to the previously created provision node.

Author:

hbrabenetz

Constructor Summary

Constructors

Constructor and Description
DefaultSettingsRepository()

Method Summary

Methods

Modifier and Type	Method and Description
int	getConnectorCount() Return the Connector Count.
Settings4jInstance	getSettings() Retrieve the appropriate Settings4j instance.
Settings4jInstance	getSettings(Settings4jFactory factory) Retrieve the appropriate Settings4j instance or create it with the give factory if doesn'r already exist.
void	resetConfiguration() Remove the Settings, Connectors and other Objects from the Repository.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSettingsRepository

public DefaultSettingsRepository()

Method Detail

getSettings

public Settings4jInstance getSettings()

Description copied from interface: Settings4jRepository

Retrieve the appropriate Settings4j instance.

Specified by:

getSettings in interface Settings4jRepository

Returns:

the appropriate Settings4jInstance

getSettings

public Settings4jInstance getSettings(Settings4jFactory factory)

Retrieve the appropriate Settings4j instance or create it with the give factory if doesn'r already exist.

Specified by:

getSettings in interface Settings4jRepository

Parameters:

factory - The factory to create a Settings4jInstance.

Returns:

the appropriate Settings4jInstance

getConnectorCount

public int getConnectorCount()

Return the Connector Count.
If the connector count is 0. the Settings will be reinitialized with the default-fallback-config in SettingsManager.getSettings()

Specified by:

getConnectorCount in interface Settings4jRepository

Returns:

The Connector Count.

resetConfiguration

public void resetConfiguration()

Remove the Settings, Connectors and other Objects from the Repository.

Make it ready to fill it with a new Configuration.

Example (maybe in an init()-Method of your Application):

 // clear Settings from "settings4j.xml"
 SettingsRepository settingsRepository = SettingsManager.getSettingsRepository();
 settingsRepository.resetConfiguration();
 
 // read XML Custome to configure the repository
 URL url = ClasspathContentResolver.getResource("customizedSettings4j.xml");
 DOMConfigurator domConfigurator = new DOMConfigurator(settingsRepository);
 domConfigurator.doConfigure(url);
 

Specified by:

resetConfiguration in interface Settings4jRepository