org.apache.brooklyn.core.config

Class SubElementConfigKey<T>

java.lang.Object

org.apache.brooklyn.core.config.BasicConfigKey<T>

org.apache.brooklyn.core.config.SubElementConfigKey<T>

All Implemented Interfaces:

java.io.Serializable, ConfigKey<T>, ConfigKeySelfExtracting<T>

public class SubElementConfigKey<T>
extends BasicConfigKey<T>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.brooklyn.core.config.BasicConfigKey

BasicConfigKey.BasicConfigKeyOverwriting<T>, BasicConfigKey.Builder<T,B extends BasicConfigKey.Builder<T,B>>

Nested classes/interfaces inherited from interface org.apache.brooklyn.config.ConfigKey

ConfigKey.HasConfigKey<T>

Field Summary

Fields

Modifier and Type	Field and Description
ConfigKey	parent

Constructor Summary

Constructors

Constructor and Description
SubElementConfigKey(ConfigKey parent, <any> type, java.lang.String name)
SubElementConfigKey(ConfigKey parent, <any> type, java.lang.String name, java.lang.String description)
SubElementConfigKey(ConfigKey parent, <any> type, java.lang.String name, java.lang.String description, T defaultValue)

Method Summary

Modifier and Type	Method and Description
T	extractValue(java.util.Map vals, ExecutionContext exec) Retrieves the value corresponding to this config key from the given map.
boolean	isSet(java.util.Map<?,?> vals)

Methods inherited from class org.apache.brooklyn.core.config.BasicConfigKey

builder, builder, builder, equals, getConstraint, getDefaultValue, getDeprecatedNames, getDescription, getInheritance, getInheritanceByContext, getInheritanceByContext, getName, getNameParts, getParentInheritance, getType, getTypeInheritance, getTypeName, getTypeToken, hasDefaultValue, hashCode, isReconfigurable, isValueValid, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

parent

public final ConfigKey parent

Constructor Detail

SubElementConfigKey

public SubElementConfigKey(ConfigKey parent,
                           <any> type,
                           java.lang.String name)

SubElementConfigKey

public SubElementConfigKey(ConfigKey parent,
                           <any> type,
                           java.lang.String name,
                           java.lang.String description)

SubElementConfigKey

public SubElementConfigKey(ConfigKey parent,
                           <any> type,
                           java.lang.String name,
                           java.lang.String description,
                           T defaultValue)

Method Detail

extractValue

public T extractValue(java.util.Map vals,
                      ExecutionContext exec)

Description copied from class: BasicConfigKey

Retrieves the value corresponding to this config key from the given map. Could be overridden by more sophisticated config keys, such as MapConfigKey etc.

Specified by:

extractValue in interface ConfigKeySelfExtracting<T>

Overrides:

extractValue in class BasicConfigKey<T>

isSet

public boolean isSet(java.util.Map<?,?> vals)

Specified by:

isSet in interface ConfigKeySelfExtracting<T>

Overrides:

isSet in class BasicConfigKey<T>

Returns:

True if there is an entry in the configMap that could be extracted