org.apache.brooklyn.core.config

Class BasicConfigKey<T>

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable, ConfigKey<T>, ConfigKeySelfExtracting<T>

Direct Known Subclasses:

AbstractStructuredConfigKey, BasicConfigKey.BasicConfigKeyOverwriting, SubElementConfigKey

public class BasicConfigKey<T>
extends java.lang.Object
implements ConfigKeySelfExtracting<T>, java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasicConfigKey.BasicConfigKeyOverwriting<T> used to record a key which overwrites another; only needed at disambiguation time if a class declares a key and an equivalent one (often inherited) which overwrites it.
static class	BasicConfigKey.Builder<T,B extends BasicConfigKey.Builder<T,B>>

Nested classes/interfaces inherited from interface org.apache.brooklyn.config.ConfigKey

ConfigKey.HasConfigKey<T>

Constructor Summary

Constructors

Constructor and Description
BasicConfigKey()
BasicConfigKey(<any> type, java.lang.String name)
BasicConfigKey(<any> type, java.lang.String name, java.lang.String description)
BasicConfigKey(<any> type, java.lang.String name, java.lang.String description, T defaultValue)
BasicConfigKey(BasicConfigKey.Builder<T,?> builder)
BasicConfigKey(java.lang.Class<T> type, java.lang.String name)
BasicConfigKey(java.lang.Class<T> type, java.lang.String name, java.lang.String description)
BasicConfigKey(java.lang.Class<T> type, java.lang.String name, java.lang.String description, T defaultValue)

Method Summary

Modifier and Type	Method and Description
static <T> BasicConfigKey.Builder<T,?>	builder(<any> type)
static <T> BasicConfigKey.Builder<T,?>	builder(<any> type, java.lang.String name)
static <T> BasicConfigKey.Builder<T,?>	builder(java.lang.String newName, ConfigKey<T> key)
boolean	equals(java.lang.Object obj)
T	extractValue(java.util.Map<?,?> vals, ExecutionContext exec) Retrieves the value corresponding to this config key from the given map.
<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.
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.
ConfigInheritance	getParentInheritance() Deprecated.
java.lang.Class<? super T>	getType() Returns the type of the configuration parameter data.
ConfigInheritance	getTypeInheritance() Deprecated.
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.
int	hashCode()
boolean	isReconfigurable()
boolean	isSet(java.util.Map<?,?> vals)
boolean	isValueValid(T value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicConfigKey

public BasicConfigKey()

BasicConfigKey

public BasicConfigKey(java.lang.Class<T> type,
                      java.lang.String name)

BasicConfigKey

public BasicConfigKey(java.lang.Class<T> type,
                      java.lang.String name,
                      java.lang.String description)

BasicConfigKey

public BasicConfigKey(java.lang.Class<T> type,
                      java.lang.String name,
                      java.lang.String description,
                      T defaultValue)

BasicConfigKey

public BasicConfigKey(<any> type,
                      java.lang.String name)

BasicConfigKey

public BasicConfigKey(<any> type,
                      java.lang.String name,
                      java.lang.String description)

BasicConfigKey

public BasicConfigKey(<any> type,
                      java.lang.String name,
                      java.lang.String description,
                      T defaultValue)

BasicConfigKey

public BasicConfigKey(BasicConfigKey.Builder<T,?> builder)

Method Detail

builder

public static <T> BasicConfigKey.Builder<T,?> builder(<any> type)

builder

public static <T> BasicConfigKey.Builder<T,?> builder(<any> type,
                                                      java.lang.String name)

builder

public static <T> BasicConfigKey.Builder<T,?> builder(java.lang.String newName,
                                                      ConfigKey<T> key)

getName

public java.lang.String getName()

Description copied from interface: ConfigKey

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

Specified by:

getName in interface ConfigKey<T>

See Also:

ConfigKey.getName()

getDeprecatedNames

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

Description copied from interface: ConfigKey

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.

Specified by:

getDeprecatedNames in interface ConfigKey<T>

See Also:

ConfigKey.getDeprecatedNames()

getTypeName

public java.lang.String getTypeName()

Description copied from interface: ConfigKey

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

Specified by:

getTypeName in interface ConfigKey<T>

See Also:

ConfigKey.getTypeName()

getType

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

Description copied from interface: ConfigKey

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.

Specified by:

getType in interface ConfigKey<T>

See Also:

ConfigKey.getType()

getTypeToken

public <any> getTypeToken()

Description copied from interface: ConfigKey

Returns the Guava TypeToken, including info on generics.

Specified by:

getTypeToken in interface ConfigKey<T>

See Also:

ConfigKey.getTypeToken()

getDescription

public java.lang.String getDescription()

Description copied from interface: ConfigKey

Returns the description of the configuration parameter, for display.

Specified by:

getDescription in interface ConfigKey<T>

See Also:

ConfigKey.getDescription()

getDefaultValue

public T getDefaultValue()

Description copied from interface: ConfigKey

Returns the default value of the configuration parameter.

Specified by:

getDefaultValue in interface ConfigKey<T>

See Also:

ConfigKey.getDefaultValue()

hasDefaultValue

public boolean hasDefaultValue()

Description copied from interface: ConfigKey

Returns true if a default configuration value has been set.

Specified by:

hasDefaultValue in interface ConfigKey<T>

See Also:

ConfigKey.hasDefaultValue()

isReconfigurable

public boolean isReconfigurable()

Specified by:

isReconfigurable in interface ConfigKey<T>

Returns:

True if the configuration can be changed at runtime.

See Also:

ConfigKey.isReconfigurable()

getInheritanceByContext

@Nullable
public ConfigInheritance getInheritanceByContext(ConfigInheritance.ConfigInheritanceContext context)

Specified by:

getInheritanceByContext in interface ConfigKey<T>

Returns:

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

getInheritanceByContext

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

Specified by:

getInheritanceByContext in interface ConfigKey<T>

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).

getInheritance

@Deprecated
 @Nullable
public ConfigInheritance getInheritance()

Deprecated.

Specified by:

getInheritance in interface ConfigKey<T>

Returns:

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

getTypeInheritance

@Deprecated
 @Nullable
public ConfigInheritance getTypeInheritance()

Deprecated.

Specified by:

getTypeInheritance in interface ConfigKey<T>

Returns:

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

getParentInheritance

@Deprecated
 @Nullable
public ConfigInheritance getParentInheritance()

Deprecated.

Specified by:

getParentInheritance in interface ConfigKey<T>

Returns:

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

getConstraint

@Nonnull
public <any> getConstraint()

Specified by:

getConstraint in interface ConfigKey<T>

Returns:

The predicate constraining the key's value.

See Also:

ConfigKey.getConstraint()

isValueValid

public boolean isValueValid(T value)

Specified by:

isValueValid in interface ConfigKey<T>

Parameters:

value - The value to test

Returns:

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

See Also:

ConfigKey#isValueValid(T)

getNameParts

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

Deprecated.

Description copied from interface: ConfigKey

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

Specified by:

getNameParts in interface ConfigKey<T>

See Also:

ConfigKey.getNameParts()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

extractValue

public T extractValue(java.util.Map<?,?> vals,
                      ExecutionContext exec)

Retrieves the value corresponding to this config key from the given map. Could be overridden by more sophisticated config keys, such as MapConfigKey etc.

Specified by:

extractValue in interface ConfigKeySelfExtracting<T>

isSet

public boolean isSet(java.util.Map<?,?> vals)

Specified by:

isSet in interface ConfigKeySelfExtracting<T>

Returns:

True if there is an entry in the configMap that could be extracted