org.apache.brooklyn.core.config

Class SetConfigKey<V>

java.lang.Object

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

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

org.apache.brooklyn.core.config.internal.AbstractCollectionConfigKey<java.util.Set<V>,java.util.Set<java.lang.Object>,V>

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

All Implemented Interfaces:

java.io.Serializable, ConfigKey<java.util.Set<V>>, StructuredConfigKey, ConfigKeySelfExtracting<java.util.Set<V>>

public class SetConfigKey<V>
extends AbstractCollectionConfigKey<java.util.Set<V>,java.util.Set<java.lang.Object>,V>

A config key representing a set of values. If a value is set using this *typed* key, it is _added_ to the set (with a warning issued if a collection is passed in). If a value is set against an equivalent *untyped* key which *is* a collection, it will be treated as a set upon discovery and used as a base to which subkey values are added. If a value is discovered against this key which is not a map or collection, it is ignored.

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 SetConfigKey.SetModification in SetConfigKey.SetModifications.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SetConfigKey.Builder<V>
static interface	SetConfigKey.SetModification<T>
static class	SetConfigKey.SetModificationBase<T>
static class	SetConfigKey.SetModifications

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
SetConfigKey(<any> subType, java.lang.String name)
SetConfigKey(<any> subType, java.lang.String name, java.lang.String description)
SetConfigKey(<any> subType, java.lang.String name, java.lang.String description, java.util.Set<? extends V> defaultValue)
SetConfigKey(SetConfigKey.Builder<V> builder)

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()

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

applyValueToMap, subKey

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

SetConfigKey

public SetConfigKey(SetConfigKey.Builder<V> builder)

SetConfigKey

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

SetConfigKey

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

SetConfigKey

public SetConfigKey(<any> subType,
                    java.lang.String name,
                    java.lang.String description,
                    java.util.Set<? extends V> defaultValue)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class BasicConfigKey<java.util.Set<V>>