org.apache.brooklyn.core.config.internal

Class AbstractStructuredConfigKey<T,RawT,V>

java.lang.Object

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

org.apache.brooklyn.core.config.internal.AbstractStructuredConfigKey<T,RawT,V>

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractCollectionConfigKey, MapConfigKey

public abstract class AbstractStructuredConfigKey<T,RawT,V>
extends BasicConfigKey<T>
implements StructuredConfigKey

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.core.config.StructuredConfigKey

StructuredConfigKey.StructuredModification<T extends StructuredConfigKey>, StructuredConfigKey.StructuredModifications

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

ConfigKey.HasConfigKey<T>

Constructor Summary

Constructors

Constructor and Description
AbstractStructuredConfigKey(<any> type, <any> subType, java.lang.String name, java.lang.String description, T defaultValue)

Method Summary

Modifier and Type	Method and Description
boolean	acceptsKeyMatch(java.lang.Object contender)
boolean	acceptsSubkey(java.lang.Object contender)
boolean	acceptsSubkeyStronglyTyped(java.lang.Object contender)
java.lang.String	extractSubKeyName(java.lang.Object o)
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)
RawT	rawValue(java.util.Map<?,?> vals) returns the entries in the map against this config key and any sub-config-keys, without resolving (like extractValue(Map, ExecutionContext) but without resolving/coercing; useful because values in this "map" are actually stored against SubElementConfigKeys

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

Methods inherited from interface org.apache.brooklyn.core.config.StructuredConfigKey

applyValueToMap

Constructor Detail

AbstractStructuredConfigKey

public AbstractStructuredConfigKey(<any> type,
                                   <any> subType,
                                   java.lang.String name,
                                   java.lang.String description,
                                   T defaultValue)

Method Detail

acceptsKeyMatch

public boolean acceptsKeyMatch(java.lang.Object contender)

Specified by:

acceptsKeyMatch in interface StructuredConfigKey

acceptsSubkey

public boolean acceptsSubkey(java.lang.Object contender)

Specified by:

acceptsSubkey in interface StructuredConfigKey

extractSubKeyName

public java.lang.String extractSubKeyName(java.lang.Object o)

acceptsSubkeyStronglyTyped

public boolean acceptsSubkeyStronglyTyped(java.lang.Object contender)

Specified by:

acceptsSubkeyStronglyTyped in interface StructuredConfigKey

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

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>

rawValue

public RawT rawValue(java.util.Map<?,?> vals)

returns the entries in the map against this config key and any sub-config-keys, without resolving (like extractValue(Map, ExecutionContext) but without resolving/coercing; useful because values in this "map" are actually stored against SubElementConfigKeys