cz.agents.alite.configurator

Interface ConfigurationInterface

All Known Implementing Classes:

MapConfiguration

public interface ConfigurationInterface

Author:

Ondrej Hrstka (ondrej.hrstka at agents.fel.cvut.cz)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsKey(String key) Returns true if Config contains key, else false
BigDecimal	getBigDecimal(String key) Retrieves BigDecimal value for given key.
BigDecimal	getBigDecimal(String key, BigDecimal defaultValue) Retrieves BigDecimal value for given key.
boolean	getBoolean(String key) Retrieves boolean value for given key.
boolean	getBoolean(String key, boolean defaultValue) Retrieves boolean value for given key.
double	getDouble(String key) Retrieves double value for given key.
double	getDouble(String key, double defaultValue) Retrieves double value for given key.
float	getFloat(String key) Retrieves float value for given key.
float	getFloat(String key, float defaultValue) Retrieves integer value for given key.
int	getInt(String key) Retrieves integer value for given key.
int	getInt(String key, int defaultValue) Retrieves integer value for given key.
List<String>	getKeyList() Gets key list
<TValue> List<TValue>	getList(String key) Retrieves List value for given key.
<TValue> List<TValue>	getList(String key, List<TValue> defaultValue) Retrieves List value for given key.
<TKey,TValue> Map<TKey,TValue>	getMap(String key) Retrieves Map value for given key.
<TKey,TValue> Map<TKey,TValue>	getMap(String key, Map<TKey,TValue> defaultValue) Retrieves Map value for given key.
Object	getObject(String key) Retrieves value for given key.
Object	getObject(String key, Object defaultValue) Retrieves value for given key.
String	getString(String key) Retrieves String value for given key.
String	getString(String key, String defaultValue) Retrieves String value for given key.
ConfigurationInterface	getSubTree(String prefix) Retrieves subtree for given prefix.
void	writeTo(Writer writer) Writes Config into given writer

Method Detail

writeTo

void writeTo(Writer writer)

Writes Config into given writer

Parameters:

writer -

containsKey

boolean containsKey(String key)

Returns true if Config contains key, else false

Parameters:

key -

Returns:

getBoolean

boolean getBoolean(String key)

Retrieves boolean value for given key.

Parameters:

key -

Returns:

Throws:

IllegalArgumentException - if value is not found or cannot be cast to boolean.

getBoolean

boolean getBoolean(String key,
                 boolean defaultValue)

Retrieves boolean value for given key. If value is not found or cannot be cast to boolean, defaultValue is returned

Parameters:

key -

defaultValue -

Returns:

getDouble

double getDouble(String key)

Retrieves double value for given key.

Parameters:

key -

Returns:

Throws:

IllegalArgumentException - if value is not found or cannot be cast to BigDecimal.

getDouble

double getDouble(String key,
               double defaultValue)

Retrieves double value for given key. If value is not found or cannot be cast to BigDecimal, defaultValue is returned

Parameters:

key -

defaultValue -

Returns:

getFloat

float getFloat(String key)

Retrieves float value for given key.

Parameters:

key -

Returns:

Throws:

IllegalArgumentException - if value is not found or cannot be cast to BigDecimal.

getFloat

float getFloat(String key,
             float defaultValue)

Retrieves integer value for given key. If value is not found or cannot be cast to float, defaultValue is returned

Parameters:

key -

defaultValue -

Returns:

getInt

int getInt(String key)

Retrieves integer value for given key.

Parameters:

key -

Returns:

Throws:

IllegalArgumentException - if value is not found or cannot be cast to integer.

getInt

int getInt(String key,
         int defaultValue)

Retrieves integer value for given key. If value is not found or cannot be cast to integer, defaultValue is returned

Parameters:

key -

defaultValue -

Returns:

getObject

Object getObject(String key)

Retrieves value for given key.

Parameters:

key -

Returns:

Throws:

IllegalArgumentException - if value is not found

getObject

Object getObject(String key,
               Object defaultValue)

Retrieves value for given key. If value is not found, defaultValue is returned

Parameters:

key -

defaultValue -

Returns:

getKeyList

List<String> getKeyList()

Gets key list

Returns:

getString

String getString(String key)

Retrieves String value for given key.

Parameters:

key -

Returns:

Throws:

IllegalArgumentException - if value is not found or cannot be cast to String.

getString

String getString(String key,
               String defaultValue)

Retrieves String value for given key. If value is not found or cannot be cast to String, defaultValue is returned

Parameters:

key -

defaultValue -

Returns:

getBigDecimal

BigDecimal getBigDecimal(String key)

Retrieves BigDecimal value for given key.

Parameters:

key -

Returns:

Throws:

IllegalArgumentException - if value is not found or cannot be cast to BigDecimal.

getBigDecimal

BigDecimal getBigDecimal(String key,
                       BigDecimal defaultValue)

Retrieves BigDecimal value for given key. If value is not found or cannot be cast to BigDecimal, defaultValue is returned

Parameters:

key -

defaultValue -

Returns:

getMap

<TKey,TValue> Map<TKey,TValue> getMap(String key)

Retrieves Map value for given key.

Type Parameters:

TKey - type of maps key

TValue - type of maps value

Parameters:

key -

Returns:

Throws:

IllegalArgumentException - if value is not found or cannot be cast to Map.

getMap

<TKey,TValue> Map<TKey,TValue> getMap(String key,
                                    Map<TKey,TValue> defaultValue)

Retrieves Map value for given key. If value is not found or cannot be cast to Map, defaultValue is returned

Type Parameters:

TKey - type of maps key

TValue - type of maps value

Parameters:

key -

Returns:

getList

<TValue> List<TValue> getList(String key)

Retrieves List value for given key.

Type Parameters:

TValue - type of list's value

Parameters:

key -

Returns:

Throws:

IllegalArgumentException - if value is not found or cannot be cast to List.

getList

<TValue> List<TValue> getList(String key,
                            List<TValue> defaultValue)

Retrieves List value for given key. If value is not found or cannot be cast to List, defaultValue is returned

Type Parameters:

TValue - type of list's value

Parameters:

key -

Returns:

getSubTree

ConfigurationInterface getSubTree(String prefix)

Retrieves subtree for given prefix.

Parameters:

prefix -

Returns:

Throws:

IllegalArgumentException - if value with given prefix is not found.