com.scriptbasic.interfaces

Interface Configuration

All Superinterfaces:

FactoryManaged

All Known Implementing Classes:

BasicConfiguration

public interface Configuration
extends FactoryManaged

Manage the configuration of the interpreter. Configuration parameters can be requested from the implementing class. Configuration is read from input stream, properties files.

When requesting individual configuration keys the implementation can look for the values in different sources. Typical implementation will look up values in the system properties and environment first before searching the configuration properties.

Author:

Peter Verhas date Jul 23, 2012

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 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() Load the default configuration.
void	setConfigProperties(Properties configProperties) Configuration of the script engine is fed from standard Java properties.

Methods inherited from interface com.scriptbasic.interfaces.FactoryManaged

setFactory

Method Detail

setConfigProperties

void setConfigProperties(Properties configProperties)

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.

Parameters:

configProperties - the properties to be used as configuration properties.

getConfigValue

String getConfigValue(String key)

Get the value of the key.

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

String getConfigValue(String key,
                    String defaultValue)

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

Parameters:

key - the configuration key, same as in 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

List<String> getConfigValueList(String key)

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.

Parameters:

key -

Returns:

the list of configured strings

loadDefaultConfiguration

void loadDefaultConfiguration()

Load the default configuration. The implementation should define some default properties file to load the configuration from.

loadConfiguration

void loadConfiguration(InputStream is)

Load the configuration from an input stream.

Parameters:

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