brooklyn.config
Interface ConfigKey<T>

public interface ConfigKey<T>

Represents the name of a piece of typed configuration data for an entity.

Two ConfigKeys should be considered equal if they have the same FQN.

Nested Class Summary

static interface

ConfigKey.HasConfigKey<T> Interface for elements which want to be treated as a config key without actually being one (e.g.

Method Summary

T	getDefaultValue() Returns the default value of the configuration parameter.
String	getDescription() Returns the description of the configuration parameter, for display.
String	getName() Returns the name of the configuration parameter, in a dot-separated namespace (FQN).
Collection<String>	getNameParts() Returns the constituent parts of the configuration parameter name as a Collection.
Class<T>	getType() Returns the type of the configuration parameter data.
String	getTypeName() Returns the name of of the configuration parameter data type, as a String.
boolean	hasDefaultValue() Returns true if a default configuration value has been set.
boolean	isReconfigurable()

Method Detail

getDescription

String getDescription()

Returns the description of the configuration parameter, for display.

getName

String getName()

Returns the name of the configuration parameter, in a dot-separated namespace (FQN).

getNameParts

Collection<String> getNameParts()

Returns the constituent parts of the configuration parameter name as a Collection.

getType

Class<T> getType()

Returns the type of the configuration parameter data.

getTypeName

String getTypeName()

Returns the name of of the configuration parameter data type, as a String.

getDefaultValue

T getDefaultValue()

Returns the default value of the configuration parameter.

hasDefaultValue

boolean hasDefaultValue()

Returns true if a default configuration value has been set.

isReconfigurable

boolean isReconfigurable()

Returns:

True if the configuration can be changed at runtime.