org.apache.brooklyn.core.config

Class ListConfigKey<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.List<V>,java.util.List<java.lang.Object>,V>

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

All Implemented Interfaces:

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

Deprecated.

since 0.6; use SetConfigKey. The ListConfigKey does not guarantee order when subkeys are used, due to distribution and the use of the ConcurrentMapAcceptingNullVals as a backing store. However the class will likely be kept around with tests for the time being as we would like to repair this.

@Deprecated
public class ListConfigKey<V>
extends AbstractCollectionConfigKey<java.util.List<V>,java.util.List<java.lang.Object>,V>

A config key representing a list of values. If a value is set on this key, it is _added_ to the list. (With a warning is 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 list upon discovery and used as a base to which subkey values are appended. 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 ListConfigKey.ListModification in ListConfigKey.ListModifications.

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	ListConfigKey.Builder<V> Deprecated.
static interface	ListConfigKey.ListModification<T> Deprecated.
static class	ListConfigKey.ListModificationBase<T> Deprecated.
static class	ListConfigKey.ListModifications Deprecated.

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

Method Summary

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

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

ListConfigKey

public ListConfigKey(ListConfigKey.Builder<V> builder)

Deprecated.

ListConfigKey

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

Deprecated.

ListConfigKey

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

Deprecated.

ListConfigKey

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

Deprecated.

Method Detail

toString

public java.lang.String toString()

Deprecated.

Overrides:

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