MapConfigKey (Apache Brooklyn)

java.lang.Object
- brooklyn.event.basic.BasicConfigKey<T>
- - brooklyn.event.basic.AbstractStructuredConfigKey<java.util.Map<java.lang.String,V>,java.util.Map<java.lang.String,java.lang.Object>,V>
  - - brooklyn.event.basic.MapConfigKey<V>

All Implemented Interfaces:

ConfigKey<java.util.Map<java.lang.String,V>>, StructuredConfigKey, ConfigKeySelfExtracting<java.util.Map<java.lang.String,V>>, java.io.Serializable
```
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 interface`	`MapConfigKey.MapModification<V>`
`static class`	`MapConfigKey.MapModificationBase<V>`
`static class`	`MapConfigKey.MapModifications`

Nested classes/interfaces inherited from class brooklyn.event.basic.BasicConfigKey
BasicConfigKey.BasicConfigKeyOverwriting<T>, BasicConfigKey.Builder<T>

Nested classes/interfaces inherited from interface brooklyn.event.basic.StructuredConfigKey
StructuredConfigKey.StructuredModification<T extends StructuredConfigKey>, StructuredConfigKey.StructuredModifications

Nested classes/interfaces inherited from interface brooklyn.config.ConfigKey
ConfigKey.HasConfigKey<T>

Field Summary
- Fields inherited from class brooklyn.event.basic.AbstractStructuredConfigKey
  subType

Constructor Summary

Constructors
Constructor and Description
`MapConfigKey(java.lang.Class<V> subType, java.lang.String name)`
`MapConfigKey(java.lang.Class<V> subType, java.lang.String name, java.lang.String description)`
`MapConfigKey(java.lang.Class<V> subType, java.lang.String name, java.lang.String description, java.util.Map<java.lang.String,V> defaultValue)`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Object`	`applyValueToMap(java.lang.Object value, java.util.Map target)` for internal use
`ConfigKey<V>`	`subKey(java.lang.String subName)`
`ConfigKey<V>`	`subKey(java.lang.String subName, java.lang.String description)`

Methods inherited from class brooklyn.event.basic.AbstractStructuredConfigKey
acceptsKeyMatch, acceptsSubkey, acceptsSubkeyStronglyTyped, extractSubKeyName, extractValue, isSet, rawValue

Methods inherited from class brooklyn.event.basic.BasicConfigKey
builder, builder, equals, getDefaultValue, getDescription, getName, getNameParts, getType, getTypeName, getTypeToken, hasDefaultValue, hashCode, isReconfigurable, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MapConfigKey

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

MapConfigKey

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

MapConfigKey

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

Method Detail

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

Class MapConfigKey<V>

Nested Class Summary

Nested classes/interfaces inherited from class brooklyn.event.basic.BasicConfigKey

Nested classes/interfaces inherited from interface brooklyn.event.basic.StructuredConfigKey

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

Field Summary

Fields inherited from class brooklyn.event.basic.AbstractStructuredConfigKey

Constructor Summary

Method Summary

Methods inherited from class brooklyn.event.basic.AbstractStructuredConfigKey

Methods inherited from class brooklyn.event.basic.BasicConfigKey

Methods inherited from class java.lang.Object

Constructor Detail

MapConfigKey

MapConfigKey

MapConfigKey

Method Detail

subKey

subKey

applyValueToMap