org.apache.brooklyn.core.config

Class MapConfigKey<V>

java.lang.Object

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

org.apache.brooklyn.core.config.internal.AbstractStructuredConfigKey<java.util.Map<java.lang.String,V>,java.util.Map<java.lang.String,java.lang.Object>,V>

org.apache.brooklyn.core.config.MapConfigKey<V>

All Implemented Interfaces:

java.io.Serializable, ConfigKey<java.util.Map<java.lang.String,V>>, StructuredConfigKey, ConfigKeySelfExtracting<java.util.Map<java.lang.String,V>>

public class MapConfigKey<V>
extends AbstractStructuredConfigKey<java.util.Map<java.lang.String,V>,java.util.Map<java.lang.String,java.lang.Object>,V>

A config key which represents a map, where contents can be accessed directly via subkeys. Items added directly to the map must be of type map, and can be updated by:

• Putting individual subkeys (SubElementConfigKey)
• Passing an an appropriate MapConfigKey.MapModification from MapConfigKey.MapModifications to clear, clear-and-set, or update
• Setting a value against a dot-extension of the key (e.g. setting a.map.subkey=1 will cause getConfig(a.map[type=MapConfigKey]) to return {subkey=1}; but note the above are preferred where possible)
• Setting a map directly against the MapConfigKey (but note that the above are preferred where possible)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapConfigKey.Builder<V>
static interface	MapConfigKey.MapModification<V>
static class	MapConfigKey.MapModificationBase<V>
static class	MapConfigKey.MapModifications

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

BasicConfigKey.BasicConfigKeyOverwriting<T>

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
MapConfigKey(<any> subType, java.lang.String name)
MapConfigKey(<any> subType, java.lang.String name, java.lang.String description)
MapConfigKey(<any> subType, java.lang.String name, java.lang.String description, java.util.Map<java.lang.String,V> defaultValue)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	applyValueToMap(java.lang.Object value, java.util.Map target) for internal use
static <V> MapConfigKey.Builder<V>	builder(MapConfigKey<V> key)
ConfigKey<V>	subKey(java.lang.String subName)
ConfigKey<V>	subKey(java.lang.String subName, java.lang.String description)
java.lang.String	toString()

Methods inherited from class org.apache.brooklyn.core.config.internal.AbstractStructuredConfigKey

acceptsKeyMatch, acceptsSubkey, acceptsSubkeyStronglyTyped, extractSubKeyName, extractValue, isSet, rawValue

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MapConfigKey

public MapConfigKey(<any> subType,
                    java.lang.String name)

MapConfigKey

public MapConfigKey(<any> subType,
                    java.lang.String name,
                    java.lang.String description)

MapConfigKey

public MapConfigKey(<any> subType,
                    java.lang.String name,
                    java.lang.String description,
                    java.util.Map<java.lang.String,V> defaultValue)

Method Detail

builder

public static <V> MapConfigKey.Builder<V> builder(MapConfigKey<V> key)

toString

public java.lang.String toString()

Overrides:

toString in class BasicConfigKey<java.util.Map<java.lang.String,V>>

subKey

public ConfigKey<V> subKey(java.lang.String subName)

subKey

public ConfigKey<V> subKey(java.lang.String subName,
                           java.lang.String description)

applyValueToMap

public java.lang.Object applyValueToMap(java.lang.Object value,
                                        java.util.Map target)

Description copied from interface: StructuredConfigKey

for internal use