Overview  Package   Class  Deprecated  Index  Help 
Brooklyn
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

brooklyn.event.basic
[Java] Class SetConfigKey

java.lang.Object
  brooklyn.event.basic.BasicConfigKey
      brooklyn.event.basic.SetConfigKey
All Implemented Interfaces:
StructuredConfigKey
public class SetConfigKey
extends BasicConfigKey

A config key representing a list of values. If a value is set on this key, it is _added_ to the list. (But a warning is issued if a collection is passed in.)

To add all items in a collection, to add a collection as a single element, to clear the list, or to set a collection (clearing first), use the relevant ListModification in ListModifications.

Specific values can be added in a replaceable way by referring to a subkey.

Nested Class Summary
interface SetConfigKey.SetModification

static class SetConfigKey.SetModificationBase

static class SetConfigKey.SetModifications

when passed as a value to a SetConfigKey, causes each of these items to be added.

 
Field Summary
java.lang.Class subType

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

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

SetConfigKey(java.lang.Class subType, java.lang.String name, java.lang.String description, java.util.Set defaultValue)

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

java.util.Set 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()

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

Field Detail

subType

public final java.lang.Class subType

 
Constructor Detail

SetConfigKey

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

SetConfigKey

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

SetConfigKey

public SetConfigKey(Class subType, String name, String description, Set defaultValue) {
public SetConfigKey(java.lang.Class subType, java.lang.String name, java.lang.String description, java.util.Set defaultValue)

 
Method Detail

applyValueToMap

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

extractValue

@SuppressWarnings("unchecked")
public Set extractValue(Map vals, ExecutionContext exec) {
public java.util.Set extractValue(java.util.Map vals, ExecutionContext exec)

isSet

public boolean isSet(Map vals) {
public boolean isSet(java.util.Map vals)

isSubKey

public boolean isSubKey(Object contender) {
public boolean isSubKey(java.lang.Object contender)

isSubKey

public boolean isSubKey(ConfigKey contender)

subKey

public ConfigKey subKey()

 

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