Package org.bedework.util.config

Class ConfigurationFileStore

java.lang.Object

org.bedework.util.config.ConfigurationFileStore

All Implemented Interfaces:

ConfigurationStore

public class ConfigurationFileStore
extends Object
implements ConfigurationStore

A configuration file store holds configurations in files within a directory.

Author:

Mike Douglass douglm

Constructor Summary

Constructors

Constructor	Description
ConfigurationFileStore(Path dirPath)

Method Summary

Modifier and Type	Method	Description
ConfigBase<?>	getConfig(String name)	Stored config must indicate class of object as an attribute
ConfigBase<?>	getConfig(String name, Class<?> cl)
List<String>	getConfigs()	List the configurations in the store
File	getDirFile()
Path	getDirPath()
ResourceBundle	getResource(String name, String locale)
ConfigurationStore	getStore(String name)	Get the named store.
boolean	readOnly()
void	saveConfiguration(ConfigBase<?> config)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bedework.util.config.ConfigurationStore

ensureDir

Constructor Detail

ConfigurationFileStore

public ConfigurationFileStore(Path dirPath)

Parameters:

dirPath - Path object already checked to be a directory

Method Detail

readOnly

public boolean readOnly()

Specified by:

readOnly in interface ConfigurationStore

Returns:

true for a read-only store.

getDirPath

public Path getDirPath()

Specified by:

getDirPath in interface ConfigurationStore

Returns:

path for this store

saveConfiguration

public void saveConfiguration(ConfigBase<?> config)
                       throws ConfigException

Specified by:

saveConfiguration in interface ConfigurationStore

Parameters:

config - to save

Throws:

ConfigException - on error

getConfig

public ConfigBase<?> getConfig(String name)
                        throws ConfigException

Description copied from interface: ConfigurationStore

Stored config must indicate class of object as an attribute

Specified by:

getConfig in interface ConfigurationStore

Parameters:

name - of the object

Returns:

config or null

Throws:

ConfigException - on error

getConfig

public ConfigBase<?> getConfig(String name,
                               Class<?> cl)
                        throws ConfigException

Specified by:

getConfig in interface ConfigurationStore

Parameters:

name - of the object

cl - - class of config object

Returns:

config or null

Throws:

ConfigException - on error

getDirFile

public File getDirFile()

getConfigs

public List<String> getConfigs()
                        throws ConfigException

Description copied from interface: ConfigurationStore

List the configurations in the store

Specified by:

getConfigs in interface ConfigurationStore

Returns:

list of configurations

Throws:

ConfigException - on error

getStore

public ConfigurationStore getStore(String name)
                            throws ConfigException

Get the named store. Create it if it does not exist

Specified by:

getStore in interface ConfigurationStore

Parameters:

name - of config

Returns:

store

Throws:

ConfigException

getResource

public ResourceBundle getResource(String name,
                                  String locale)
                           throws ConfigException

Specified by:

getResource in interface ConfigurationStore

Parameters:

name - of bundle

locale - null for default or a locale String e.g. en_US

Returns:

a ResourceBundle object or null.

Throws:

ConfigException - on error