ConfigKey (Brooklyn)

Overview

Package

Class

Deprecated

Index

Help

Brooklyn

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | METHOD

DETAIL: FIELD | METHOD

brooklyn.config
[Java] Interface ConfigKey

public interface ConfigKey

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
`interface`	`ConfigKey.HasConfigKey` Interface for elements which want to be treated as a config key without actually being one (e.g. config attribute sensors).

Method Summary
`java.lang.Object`	`getDefaultValue()` Returns the default value of the configuration parameter.
`java.lang.String`	`getDescription()` Returns the description of the configuration parameter, for display.
`java.lang.String`	`getName()` Returns the name of the configuration parameter, in a dot-separated namespace (FQN).
`java.util.Collection`	`getNameParts()` Returns the constituent parts of the configuration parameter name as a java.util.Collection.
`java.lang.Class`	`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 java.lang.String.
`TypeToken`	`getTypeToken()` Returns the Guava TypeToken, including info on generics.
`boolean`	`hasDefaultValue()` Returns true if a default configuration value has been set.
`boolean`	`isReconfigurable()` @return True if the configuration can be changed at runtime.

Method Detail

getDefaultValue

public java.lang.Object getDefaultValue()

Returns the default value of the configuration parameter.

getDescription

public java.lang.String getDescription()

Returns the description of the configuration parameter, for display.

getName

public java.lang.String getName()

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

getNameParts

public java.util.Collection getNameParts()

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

getType

public java.lang.Class 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 this returns Class --- this is of course because there is no actual Class> instance.

getTypeName

public java.lang.String getTypeName()

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

getTypeToken

public TypeToken getTypeToken()

Returns the Guava TypeToken, including info on generics.

hasDefaultValue

public boolean hasDefaultValue()

Returns true if a default configuration value has been set.

isReconfigurable

public boolean isReconfigurable()

Returns:: True if the configuration can be changed at runtime.

brooklyn.config [Java] Interface ConfigKey