ConfigKey (Apache Brooklyn)

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

Methods
Modifier and Type	Method and Description
	`getConstraint()`
`T`	`getDefaultValue()` Returns the default value of the configuration parameter.
`java.lang.String`	`getDescription()` Returns the description of the configuration parameter, for display.
`ConfigInheritance`	`getInheritance()`
`java.lang.String`	`getName()` Returns the name of the configuration parameter, in a dot-separated namespace (FQN).
`java.util.Collection<java.lang.String>`	`getNameParts()` Returns the constituent parts of the configuration parameter name as a `Collection`.
`java.lang.Class<? super T>`	`getType()` Returns the type of the configuration parameter data.
`java.lang.String`	`getTypeName()` Returns the name of of the configuration parameter data type, as a `String`.
	`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).
  - getNameParts
```
java.util.Collection<java.lang.String> getNameParts()
```
    Returns the constituent parts of the configuration parameter name as a Collection.
  - getTypeToken
```
 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.
  - getInheritance
```
@Nullable
ConfigInheritance getInheritance()
```
    Returns:
    The inheritance model, or null for the default in any context.
  - getConstraint
```
@Nonnull
 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.

Interface ConfigKey<T>

Nested Class Summary

Method Summary

Method Detail

getDescription

getName

getNameParts

getTypeToken

getType

getTypeName

getDefaultValue

hasDefaultValue

isReconfigurable

getInheritance

getConstraint

isValueValid