org.eclipse.birt.core.config

Interface IConfigVarManager

public interface IConfigVarManager

Allows BIRT components to access configuration variables in a uniform way.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getConfigBoolean(java.lang.String key)
java.lang.Integer	getConfigInteger(java.lang.String key)
int	getConfigInteger(java.lang.String key, int defaultValue)
java.lang.String	getConfigVar(java.lang.String key)
java.lang.String	getConfigVar(java.lang.String key, java.lang.String defaultValue)

Method Detail

getConfigVar

java.lang.String getConfigVar(java.lang.String key)

Parameters:

key - the configuration variable name

Returns:

The value for the configuration variable. null if it is not set.

getConfigVar

java.lang.String getConfigVar(java.lang.String key,
                            java.lang.String defaultValue)

Parameters:

key - the configuration variable name

defaultValue - returns this value is the configuration variable is not set

Returns:

The value for the configuration variable. In case the config var is not set, or there is an exception, defaultValue is returned.

getConfigBoolean

boolean getConfigBoolean(java.lang.String key)

Parameters:

key - the configuration variable name

defaultValue - returns this value is the configuration variable is not set

Returns:

true if set to true (case insensitive), false in any other cases

getConfigInteger

java.lang.Integer getConfigInteger(java.lang.String key)

Parameters:

key - the configuration variable name

Returns:

the value for the configuration variable. returns null if the config var is not set or not set to an integer or any other exception happens.

getConfigInteger

int getConfigInteger(java.lang.String key,
                   int defaultValue)

Parameters:

key - the configuration variable name

defaultValue - returns this value is the configuration variable is not set

Returns:

the value for the configuration variable. In case the config var is not set, or not set to a number, or there is an exception, defaultValue is returned.