com.googlecode.jmxtrans.model.output

Class Settings

java.lang.Object

com.googlecode.jmxtrans.model.output.Settings

public final class Settings
extends Object

Method Summary

Modifier and Type	Method and Description
static Boolean	getBooleanSetting(Map<String,Object> settings, String key) Returns a boolean value for the key, defaults to false if not specified.
static Boolean	getBooleanSetting(Map<String,Object> settings, String key, Boolean defaultVal) Gets a Boolean value for the key, returning the default value given if not specified or not a valid boolean value.
static Integer	getIntegerSetting(Map<String,Object> settings, String key, Integer defaultVal) Gets an Integer value for the key, returning the default value given if not specified or not a valid numeric value.
protected static int	getIntSetting(Map<String,Object> settings, String key, int defaultVal) Gets an int value for the setting, returning the default value if not specified.
static String	getStringSetting(Map<String,Object> settings, String key, String defaultVal) Gets a String value for the setting, returning the default value if not specified.

Methods inherited from class java.lang.Object

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

Method Detail

getBooleanSetting

public static Boolean getBooleanSetting(Map<String,Object> settings,
                                        String key)

Returns a boolean value for the key, defaults to false if not specified. This is equivalent to calling getBooleanSetting(java.util.Map, String, Boolean).

Parameters:

settings -

key - the key value to get the boolean setting for

Returns:

the value set for the key, defaults to false

getBooleanSetting

public static Boolean getBooleanSetting(Map<String,Object> settings,
                                        String key,
                                        Boolean defaultVal)

Gets a Boolean value for the key, returning the default value given if not specified or not a valid boolean value.

Parameters:

settings -

key - the key to get the boolean setting for

defaultVal - the default value to return if the setting was not specified or was not coercible to a Boolean value

Returns:

the Boolean value for the setting

getIntegerSetting

public static Integer getIntegerSetting(Map<String,Object> settings,
                                        String key,
                                        Integer defaultVal)

Gets an Integer value for the key, returning the default value given if not specified or not a valid numeric value.

Parameters:

settings -

key - the key to get the Integer setting for

defaultVal - the default value to return if the setting was not specified or was not coercible to an Integer value

Returns:

the Integer value for the setting

getStringSetting

public static String getStringSetting(Map<String,Object> settings,
                                      String key,
                                      String defaultVal)

Gets a String value for the setting, returning the default value if not specified.

Parameters:

settings -

key - the key to get the String setting for

defaultVal - the default value to return if the setting was not specified

Returns:

the String value for the setting

getIntSetting

protected static int getIntSetting(Map<String,Object> settings,
                                   String key,
                                   int defaultVal)
                            throws IllegalArgumentException

Gets an int value for the setting, returning the default value if not specified.

Parameters:

settings -

key - the key to get the int value for

defaultVal - default value if the setting was not specified

Returns:

the int value for the setting

Throws:

IllegalArgumentException - if setting does not contain an int