Brooklyn

brooklyn.event.basic
[Java] Class MapConfigKey

java.lang.Object
  brooklyn.event.basic.BasicConfigKey
      brooklyn.event.basic.MapConfigKey
All Implemented Interfaces:
StructuredConfigKey

public class MapConfigKey
extends BasicConfigKey

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 are put (as individual subkeys).

You can also pass an appropriate MapModification from MapModifications to clear (and clear-and-set).


Nested Class Summary
interface MapConfigKey.MapModification

static class MapConfigKey.MapModifications

 
Field Summary
java.lang.Class subType

 
Constructor Summary
MapConfigKey(java.lang.Class subType, java.lang.String name)

MapConfigKey(java.lang.Class subType, java.lang.String name, java.lang.String description)

MapConfigKey(java.lang.Class subType, java.lang.String name, java.lang.String description, java.util.Map defaultValue)

 
Method Summary
protected java.lang.Object applyEntryValueToMap(Entry value, java.util.Map target)

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

java.lang.String extractSubKeyName(ConfigKey subKey)

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

boolean isSet(java.util.Map vals)

boolean isSubKey(java.lang.Object contender)

boolean isSubKey(ConfigKey contender)

ConfigKey subKey(java.lang.String subName)

ConfigKey subKey(java.lang.String subName, java.lang.String description)

 
Methods inherited from class BasicConfigKey
equals, extractValue, getDefaultValue, getDescription, getName, getNameParts, getType, getTypeName, hasDefaultValue, hashCode, isSet, resolveValue, resolveValue, toString
 

Field Detail

subType

public final java.lang.Class subType


 
Constructor Detail

MapConfigKey

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


MapConfigKey

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


MapConfigKey

@SuppressWarnings({ "unchecked", "rawtypes" })
public MapConfigKey(java.lang.Class subType, java.lang.String name, java.lang.String description, java.util.Map defaultValue)


 
Method Detail

applyEntryValueToMap

@SuppressWarnings({ "rawtypes", "unchecked" })
protected java.lang.Object applyEntryValueToMap(Entry value, java.util.Map target)


applyValueToMap

@SuppressWarnings({ "rawtypes", "unchecked" })
@Override
public java.lang.Object applyValueToMap(java.lang.Object value, java.util.Map target)


extractSubKeyName

public java.lang.String extractSubKeyName(ConfigKey subKey)


extractValue

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


isSet

@Override
public boolean isSet(java.util.Map vals)


isSubKey

public boolean isSubKey(java.lang.Object contender)


isSubKey

public boolean isSubKey(ConfigKey contender)


subKey

public ConfigKey subKey(java.lang.String subName)


subKey

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


 

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.