com.eibus.management

Interface ISettingDefinition<T>

public interface ISettingDefinition<T>

Defines a management setting. Examples of settings are pool size, queue length, etc.

Author:

Bert Roos

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Get the name of this setting
ISettingsCollection	getSettingsCollection() Retrieves the settings collection containing this setting definition.
java.lang.Class<T>	getType() Get the type of this setting
T	getTypedValueFromString(java.lang.String str, T defaultValue) Convert the given string to the object value as applicable for this setting definition.
T	getValue() Get the value of this setting

Method Detail

getValue

T getValue()

Get the value of this setting

Returns:

the setting value

getName

java.lang.String getName()

Get the name of this setting

Returns:

the setting name

getTypedValueFromString

T getTypedValueFromString(java.lang.String str,
                          T defaultValue)

Convert the given string to the object value as applicable for this setting definition.

Parameters:

str - the string to convert

defaultValue - the default value in case the string is a null string

Returns:

the object representation of the given string

getSettingsCollection

ISettingsCollection getSettingsCollection()

Retrieves the settings collection containing this setting definition.

Returns:

the settings collection containing this setting definition.

getType

java.lang.Class<T> getType()

Get the type of this setting

Returns:

the type of this setting