org.apache.brooklyn.config

Interface ConfigKey<T>

All Known Subinterfaces:

ConfigKeySelfExtracting<T>

All Known Implementing Classes:

AbstractCollectionConfigKey, AbstractStructuredConfigKey, BasicConfigKey, BasicConfigKey.BasicConfigKeyOverwriting, ListConfigKey, MapConfigKey, SetConfigKey, SubElementConfigKey

public interface ConfigKey<T>

Represents the name of a piece of typed configuration data for an entity.

Two ConfigKeys should be considered equal if they have the same FQN.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ConfigKey.HasConfigKey<T> Interface for elements which want to be treated as a config key without actually being one (e.g.

Method Summary

Modifier and Type	Method and Description
<any>	getConstraint()
T	getDefaultValue() Returns the default value of the configuration parameter.
java.util.Collection<java.lang.String>	getDeprecatedNames() Returns deprecated names that will could also be used, but that are discouraged and will likely not be supported for the given config key in future versions.
java.lang.String	getDescription() Returns the description of the configuration parameter, for display.
ConfigInheritance	getInheritance() Deprecated. since 0.10.0 use getInheritanceByContext()
java.util.Map<ConfigInheritance.ConfigInheritanceContext,ConfigInheritance>	getInheritanceByContext()
ConfigInheritance	getInheritanceByContext(ConfigInheritance.ConfigInheritanceContext context)
java.lang.String	getName() Returns the name of the configuration parameter, in a dot-separated namespace (FQN).
java.util.Collection<java.lang.String>	getNameParts() Deprecated. since 0.12.0; use getName()
ConfigInheritance	getParentInheritance() Deprecated. since 0.10.0 use getInheritanceByContext()
java.lang.Class<? super T>	getType() Returns the type of the configuration parameter data.
ConfigInheritance	getTypeInheritance() Deprecated. since 0.10.0 use getInheritanceByContext()
java.lang.String	getTypeName() Returns the name of of the configuration parameter data type, as a String.
<any>	getTypeToken() Returns the Guava TypeToken, including info on generics.
boolean	hasDefaultValue() Returns true if a default configuration value has been set.
boolean	isReconfigurable()
boolean	isValueValid(T value)

Method Detail

getDescription

java.lang.String getDescription()

Returns the description of the configuration parameter, for display.

getName

java.lang.String getName()

Returns the name of the configuration parameter, in a dot-separated namespace (FQN).

getDeprecatedNames

java.util.Collection<java.lang.String> getDeprecatedNames()

Returns deprecated names that will could also be used, but that are discouraged and will likely not be supported for the given config key in future versions.

getNameParts

@Deprecated
java.util.Collection<java.lang.String> getNameParts()

Deprecated. since 0.12.0; use getName()

Returns the constituent parts of the configuration parameter name as a Collection.

getTypeToken

<any> getTypeToken()

Returns the Guava TypeToken, including info on generics.

getType

java.lang.Class<? super T> getType()

Returns the type of the configuration parameter data.

This returns a "super" of T only in the case where T is generified, and in such cases it returns the Class instance for the unadorned T --- i.e. for List<String> this returns Class<List> --- this is of course because there is no actual Class<List<String>> instance.

getTypeName

java.lang.String getTypeName()

Returns the name of of the configuration parameter data type, as a String.

getDefaultValue

T getDefaultValue()

Returns the default value of the configuration parameter.

hasDefaultValue

boolean hasDefaultValue()

Returns true if a default configuration value has been set.

isReconfigurable

boolean isReconfigurable()

Returns:

True if the configuration can be changed at runtime.

getTypeInheritance

@Deprecated
 @Nullable
ConfigInheritance getTypeInheritance()

Deprecated. since 0.10.0 use getInheritanceByContext()

Returns:

The sub-typing inheritance model, or null for the default in any context.

getParentInheritance

@Deprecated
 @Nullable
ConfigInheritance getParentInheritance()

Deprecated. since 0.10.0 use getInheritanceByContext()

Returns:

The inheritance-from-parent-entities model, or null for the default in any context.

getInheritance

@Deprecated
 @Nullable
ConfigInheritance getInheritance()

Deprecated. since 0.10.0 use getInheritanceByContext()

Returns:

The inheritance model, or null for the default in any context.

getInheritanceByContext

@Nullable
ConfigInheritance getInheritanceByContext(ConfigInheritance.ConfigInheritanceContext context)

Returns:

The inheritance model for this key in the given ConfigInheritance.ConfigInheritanceContext

getInheritanceByContext

java.util.Map<ConfigInheritance.ConfigInheritanceContext,ConfigInheritance> getInheritanceByContext()

Returns:

A summary of the inheritance models for this key in various ConfigInheritance.ConfigInheritanceContext instances. Implementations may have a simple map, whereas others could be more sophisticated. #getInheritanceByContext(ConfigInheritanceContext) may be preferred if inheritance contexts are complex (but usually, and in brooklyn, they aren't).

getConstraint

@Nonnull
<any> getConstraint()

Returns:

The predicate constraining the key's value.

isValueValid

boolean isValueValid(T value)

Parameters:

value - The value to test

Returns:

True if the given value is acceptable per the constraints on this key.