com.scriptbasic.configuration

Class BasicConfiguration

java.lang.Object

com.scriptbasic.configuration.BasicConfiguration

All Implemented Interfaces:

Configuration, FactoryManaged

public class BasicConfiguration
extends Object
implements Configuration

Author:

Peter Verhas date July 23, 2012

Constructor Summary

Constructors

Constructor and Description
BasicConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
String	getConfigValue(String key) Get the value of the key.
String	getConfigValue(String key, String defaultValue) Complimentary method calling Configuration.getConfigValue(String) but returning the defaultValue instead of null if the key is not configured.
List<String>	getConfigValueList(String key) Returns a list of strings that are the values assigned to the key in the configuration.
void	loadConfiguration(InputStream is) Load the configuration from an input stream.
void	loadDefaultConfiguration() The default configuration is stored in the file sb4j.properties or in the file defined by the system property named sb4j.configuration.
void	setConfigProperties(Properties configProperties) Configuration of the script engine is fed from standard Java properties.
void	setFactory(Factory factory) When a factory creates an instance of a class implementing this interface this method is called to register the factory that created the instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicConfiguration

public BasicConfiguration()

Method Detail

setFactory

public void setFactory(Factory factory)

Description copied from interface: FactoryManaged

When a factory creates an instance of a class implementing this interface this method is called to register the factory that created the instance.

Specified by:

setFactory in interface FactoryManaged

Parameters:

factory - the factory that manages the instance.

setConfigProperties

public void setConfigProperties(Properties configProperties)

Description copied from interface: Configuration

Configuration of the script engine is fed from standard Java properties. Calling this method the caller can set the properties for the configuration. The properties passed as argument will be used as configuration solely and will NOT be merged with the keys and values of other property files.

The fact that all other, possibly already loaded properties are not taken into account does not affect the fact that the configuration implementation itself may search other sources in addition to the properties to locate values for certain configuration keys.

Specified by:

setConfigProperties in interface Configuration

Parameters:

configProperties - the configProperties to set

getConfigValue

public String getConfigValue(String key)

Description copied from interface: Configuration

Get the value of the key.

Specified by:

getConfigValue in interface Configuration

Parameters:

key - the configuration key for which the value is looked up.

Returns:

the string value of the configuration or null if the key is not configured.

getConfigValue

public String getConfigValue(String key,
                    String defaultValue)

Description copied from interface: Configuration

Complimentary method calling Configuration.getConfigValue(String) but returning the defaultValue instead of null if the key is not configured.

Specified by:

getConfigValue in interface Configuration

Parameters:

key - the configuration key, same as in Configuration.getConfigValue(String).

defaultValue - is the default value string to return if the configuration key is not found

Returns:

the string value of the configuration or defaultValue if the key is not configured.

getConfigValueList

public List<String> getConfigValueList(String key)

Description copied from interface: Configuration

Returns a list of strings that are the values assigned to the key in the configuration. List of strings in the configuration should be defined using the notation key'.n' where 'n' starts with zero and should increment by one continuously.

Specified by:

getConfigValueList in interface Configuration

Returns:

the list of configured strings

loadDefaultConfiguration

public void loadDefaultConfiguration()

The default configuration is stored in the file sb4j.properties or in the file defined by the system property named sb4j.configuration.

Specified by:

loadDefaultConfiguration in interface Configuration

See Also:

Configuration.loadDefaultConfiguration()

loadConfiguration

public void loadConfiguration(InputStream is)

Description copied from interface: Configuration

Load the configuration from an input stream.

Specified by:

loadConfiguration in interface Configuration

Parameters:

is - the input stream that is used to read the content of the properties file.