org.irenical.jindy

Interface Config

public interface Config

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean(String key, boolean defaultValue) Returns the boolean value for given property
float	getFloat(String key, float defaultValue) Returns the float value for given property
int	getInt(String key, int defaultValue) Returns the int value for given property
boolean	getMandatoryBoolean(String key) Returns the boolean value for given property
float	getMandatoryFloat(String key) Returns the float value for given property
int	getMandatoryInt(String key) Returns the int value for given property
String	getMandatoryString(String key) Returns the string value for given property
String	getString(String key) Returns the string value for given property
String	getString(String key, String defaultValue) Returns the string value for given property
String[]	getStringArray(String key) Returns the string array for given property
void	listen(String key, ConfigChangedCallback callback) Registers a listener on given property.
void	setProperty(String key, Object value) Set a property, this will replace any previously set values.
void	unListen(ConfigChangedCallback callback) Unregisters listener on all keys

Method Detail

listen

void listen(String key,
            ConfigChangedCallback callback)

Registers a listener on given property. It will be call whenever the property's value is changed

Parameters:

key - - the property name

callback - - the callback function

unListen

void unListen(ConfigChangedCallback callback)

Unregisters listener on all keys

Parameters:

callback - - the callback function earlier registered with listen()

getMandatoryBoolean

boolean getMandatoryBoolean(String key)
                     throws ConfigNotFoundException

Returns the boolean value for given property

Parameters:

key - - the property name

Returns:

true or false

Throws:

ConfigNotFoundException - - if the property is not set

getBoolean

boolean getBoolean(String key,
                   boolean defaultValue)

Returns the boolean value for given property

Parameters:

key - - the property name

defaultValue - - the returned value if the property is not set

Returns:

true, false or defaultValue if not defined

getMandatoryFloat

float getMandatoryFloat(String key)
                 throws ConfigNotFoundException

Returns the float value for given property

Parameters:

key - - the property name

Returns:

the float value

Throws:

ConfigNotFoundException - - if the property is not set

getFloat

float getFloat(String key,
               float defaultValue)

Returns the float value for given property

Parameters:

key - - the property name

defaultValue - - the returned value if the property is not set

Returns:

a float or defaultValue if none is defined

getMandatoryInt

int getMandatoryInt(String key)
             throws ConfigNotFoundException

Returns the int value for given property

Parameters:

key - - the property name

Returns:

the integer value

Throws:

ConfigNotFoundException - - if the property is not set

getInt

int getInt(String key,
           int defaultValue)

Returns the int value for given property

Parameters:

key - - the property name

defaultValue - - the returned value if the property is not set

Returns:

an int or defaultValue if none is defined

getMandatoryString

String getMandatoryString(String key)
                   throws ConfigNotFoundException

Returns the string value for given property

Parameters:

key - - the property name

Returns:

the string value (can be empty)

Throws:

ConfigNotFoundException - - if the property is not set

getString

String getString(String key)

Returns the string value for given property

Parameters:

key - - the property name

Returns:

a string or null if none is defined

getString

String getString(String key,
                 String defaultValue)

Returns the string value for given property

Parameters:

key - - the property name

defaultValue - - the returned value if the property is not set

Returns:

a string or defaultValue if none is defined

getStringArray

String[] getStringArray(String key)

Returns the string array for given property

Parameters:

key - - the property name

Returns:

a string array

setProperty

void setProperty(String key,
                 Object value)

Set a property, this will replace any previously set values.

Parameters:

key - the key/name of the property to alter

value - the value to be altered