ConfigKeys (Apache Brooklyn)

java.lang.Object
- brooklyn.entity.basic.ConfigKeys

public class ConfigKeys
extends java.lang.Object

Dictionary of ConfigKey entries.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ConfigKeys.DynamicKeys

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConfigKeys.DynamicKeys`

Constructor Summary

Constructors
Constructor and Description

ConfigKeys()

Constructors
Constructor and Description
`ConfigKeys()`

Method Summary

Methods
Modifier and Type	Method and Description
`static <T> BasicConfigKey.Builder<T>`	`builder(java.lang.Class<T> type)`
`static <T> BasicConfigKey.Builder<T>`	`builder(com.google.common.reflect.TypeToken<T> type)`
`static <T> ConfigKey<T>`	`convert(ConfigKey<T> key, com.google.common.base.CaseFormat inputCaseStrategy, com.google.common.base.CaseFormat outputCaseStrategy)` converts the name of the key from one case-strategy (e.g.
`static ConfigKey<java.lang.Boolean>`	`newBooleanConfigKey(java.lang.String name)`
`static ConfigKey<java.lang.Boolean>`	`newBooleanConfigKey(java.lang.String name, java.lang.String description)`
`static ConfigKey<java.lang.Boolean>`	`newBooleanConfigKey(java.lang.String name, java.lang.String description, java.lang.Boolean defaultValue)`
`static <T> ConfigKey<T>`	`newConfigKey(java.lang.Class<T> type, java.lang.String name)`
`static <T> ConfigKey<T>`	`newConfigKey(java.lang.Class<T> type, java.lang.String name, java.lang.String description)`
`static <T> ConfigKey<T>`	`newConfigKey(java.lang.Class<T> type, java.lang.String name, java.lang.String description, T defaultValue)`
`static <T> ConfigKey<T>`	`newConfigKey(java.lang.String name, java.lang.String description, T defaultValue)` Infers the type from the default value
`static <T> ConfigKey<T>`	`newConfigKey(com.google.common.reflect.TypeToken<T> type, java.lang.String name)`
`static <T> ConfigKey<T>`	`newConfigKey(com.google.common.reflect.TypeToken<T> type, java.lang.String name, java.lang.String description)`
`static <T> ConfigKey<T>`	`newConfigKey(com.google.common.reflect.TypeToken<T> type, java.lang.String name, java.lang.String description, T defaultValue)`
`static <T> ConfigKey<T>`	`newConfigKeyRenamed(java.lang.String newName, ConfigKey<T> key)`
`static <T> ConfigKey<T>`	`newConfigKeyWithDefault(ConfigKey<T> parent, java.lang.String newDescription, T defaultValue)`
`static <T> ConfigKey<T>`	`newConfigKeyWithDefault(ConfigKey<T> parent, T defaultValue)`
`static <T> ConfigKey<T>`	`newConfigKeyWithPrefix(java.lang.String prefix, ConfigKey<T> key)`
`static ConfigKey<java.lang.Double>`	`newDoubleConfigKey(java.lang.String name)`
`static ConfigKey<java.lang.Double>`	`newDoubleConfigKey(java.lang.String name, java.lang.String description)`
`static ConfigKey<java.lang.Double>`	`newDoubleConfigKey(java.lang.String name, java.lang.String description, java.lang.Double defaultValue)`
`static ConfigKey<Duration>`	`newDurationConfigKey(java.lang.String name)`
`static ConfigKey<Duration>`	`newDurationConfigKey(java.lang.String name, java.lang.String description)`
`static ConfigKey<Duration>`	`newDurationConfigKey(java.lang.String name, java.lang.String description, Duration defaultValue)`
`static ConfigKey<java.lang.Integer>`	`newIntegerConfigKey(java.lang.String name)`
`static ConfigKey<java.lang.Integer>`	`newIntegerConfigKey(java.lang.String name, java.lang.String description)`
`static ConfigKey<java.lang.Integer>`	`newIntegerConfigKey(java.lang.String name, java.lang.String description, java.lang.Integer defaultValue)`
`static AttributeSensorAndConfigKey<java.lang.Integer,java.lang.Integer>`	`newIntegerSensorAndConfigKey(java.lang.String name, java.lang.String description)`
`static AttributeSensorAndConfigKey<java.lang.Integer,java.lang.Integer>`	`newIntegerSensorAndConfigKey(java.lang.String name, java.lang.String description, java.lang.Integer defaultValue)`
`static ConfigKey<java.lang.Long>`	`newLongConfigKey(java.lang.String name)`
`static ConfigKey<java.lang.Long>`	`newLongConfigKey(java.lang.String name, java.lang.String description)`
`static ConfigKey<java.lang.Long>`	`newLongConfigKey(java.lang.String name, java.lang.String description, java.lang.Long defaultValue)`
`static PortAttributeSensorAndConfigKey`	`newPortSensorAndConfigKey(java.lang.String name, java.lang.String description)`
`static PortAttributeSensorAndConfigKey`	`newPortSensorAndConfigKey(java.lang.String name, java.lang.String description, java.lang.Object defaultValue)`
`static <T> AttributeSensorAndConfigKey<T,T>`	`newSensorAndConfigKey(java.lang.Class<T> type, java.lang.String name, java.lang.String description)`
`static <T> AttributeSensorAndConfigKey<T,T>`	`newSensorAndConfigKey(java.lang.Class<T> type, java.lang.String name, java.lang.String description, T defaultValue)`
`static <T> AttributeSensorAndConfigKey<T,T>`	`newSensorAndConfigKey(com.google.common.reflect.TypeToken<T> type, java.lang.String name, java.lang.String description)`
`static <T> AttributeSensorAndConfigKey<T,T>`	`newSensorAndConfigKey(com.google.common.reflect.TypeToken<T> type, java.lang.String name, java.lang.String description, T defaultValue)`
`static ConfigKey<java.lang.String>`	`newStringConfigKey(java.lang.String name)`
`static ConfigKey<java.lang.String>`	`newStringConfigKey(java.lang.String name, java.lang.String description)`
`static ConfigKey<java.lang.String>`	`newStringConfigKey(java.lang.String name, java.lang.String description, java.lang.String defaultValue)`
`static AttributeSensorAndConfigKey<java.lang.String,java.lang.String>`	`newStringSensorAndConfigKey(java.lang.String name, java.lang.String description)`
`static AttributeSensorAndConfigKey<java.lang.String,java.lang.String>`	`newStringSensorAndConfigKey(java.lang.String name, java.lang.String description, java.lang.String defaultValue)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ConfigKeys
```
public ConfigKeys()
```

Method Detail

newConfigKey

public static <T> ConfigKey<T> newConfigKey(java.lang.Class<T> type,
                            java.lang.String name)

newConfigKey

public static <T> ConfigKey<T> newConfigKey(java.lang.Class<T> type,
                            java.lang.String name,
                            java.lang.String description)

newConfigKey

public static <T> ConfigKey<T> newConfigKey(com.google.common.reflect.TypeToken<T> type,
                            java.lang.String name)

newConfigKey

public static <T> ConfigKey<T> newConfigKey(com.google.common.reflect.TypeToken<T> type,
                            java.lang.String name,
                            java.lang.String description)

newConfigKey

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

newConfigKey

public static <T> ConfigKey<T> newConfigKey(com.google.common.reflect.TypeToken<T> type,
                            java.lang.String name,
                            java.lang.String description,
                            T defaultValue)

newSensorAndConfigKey

public static <T> AttributeSensorAndConfigKey<T,T> newSensorAndConfigKey(java.lang.Class<T> type,
                                                         java.lang.String name,
                                                         java.lang.String description)

newSensorAndConfigKey

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

newSensorAndConfigKey

public static <T> AttributeSensorAndConfigKey<T,T> newSensorAndConfigKey(com.google.common.reflect.TypeToken<T> type,
                                                         java.lang.String name,
                                                         java.lang.String description)

newSensorAndConfigKey

public static <T> AttributeSensorAndConfigKey<T,T> newSensorAndConfigKey(com.google.common.reflect.TypeToken<T> type,
                                                         java.lang.String name,
                                                         java.lang.String description,
                                                         T defaultValue)

newStringSensorAndConfigKey

public static AttributeSensorAndConfigKey<java.lang.String,java.lang.String> newStringSensorAndConfigKey(java.lang.String name,
                                                                                         java.lang.String description)

newStringSensorAndConfigKey

public static AttributeSensorAndConfigKey<java.lang.String,java.lang.String> newStringSensorAndConfigKey(java.lang.String name,
                                                                                         java.lang.String description,
                                                                                         java.lang.String defaultValue)

newIntegerSensorAndConfigKey

public static AttributeSensorAndConfigKey<java.lang.Integer,java.lang.Integer> newIntegerSensorAndConfigKey(java.lang.String name,
                                                                                            java.lang.String description)

newIntegerSensorAndConfigKey

public static AttributeSensorAndConfigKey<java.lang.Integer,java.lang.Integer> newIntegerSensorAndConfigKey(java.lang.String name,
                                                                                            java.lang.String description,
                                                                                            java.lang.Integer defaultValue)

newPortSensorAndConfigKey

public static PortAttributeSensorAndConfigKey newPortSensorAndConfigKey(java.lang.String name,
                                                        java.lang.String description)

newPortSensorAndConfigKey

public static PortAttributeSensorAndConfigKey newPortSensorAndConfigKey(java.lang.String name,
                                                        java.lang.String description,
                                                        java.lang.Object defaultValue)

newConfigKey

public static <T> ConfigKey<T> newConfigKey(java.lang.String name,
                            java.lang.String description,
                            @Nonnull
                            T defaultValue)

Infers the type from the default value

builder

public static <T> BasicConfigKey.Builder<T> builder(java.lang.Class<T> type)

builder

public static <T> BasicConfigKey.Builder<T> builder(com.google.common.reflect.TypeToken<T> type)

newConfigKeyWithDefault

public static <T> ConfigKey<T> newConfigKeyWithDefault(ConfigKey<T> parent,
                                       T defaultValue)

newConfigKeyWithDefault

public static <T> ConfigKey<T> newConfigKeyWithDefault(ConfigKey<T> parent,
                                       java.lang.String newDescription,
                                       T defaultValue)

newConfigKeyRenamed

public static <T> ConfigKey<T> newConfigKeyRenamed(java.lang.String newName,
                                   ConfigKey<T> key)

newConfigKeyWithPrefix

public static <T> ConfigKey<T> newConfigKeyWithPrefix(java.lang.String prefix,
                                      ConfigKey<T> key)

convert

public static <T> ConfigKey<T> convert(ConfigKey<T> key,
                       com.google.common.base.CaseFormat inputCaseStrategy,
                       com.google.common.base.CaseFormat outputCaseStrategy)

converts the name of the key from one case-strategy (e.g. lowerCamel) to andother (e.g. lower-hyphen)

newStringConfigKey

public static ConfigKey<java.lang.String> newStringConfigKey(java.lang.String name)

newStringConfigKey

public static ConfigKey<java.lang.String> newStringConfigKey(java.lang.String name,
                                             java.lang.String description)

newStringConfigKey

public static ConfigKey<java.lang.String> newStringConfigKey(java.lang.String name,
                                             java.lang.String description,
                                             java.lang.String defaultValue)

newIntegerConfigKey

public static ConfigKey<java.lang.Integer> newIntegerConfigKey(java.lang.String name)

newIntegerConfigKey

public static ConfigKey<java.lang.Integer> newIntegerConfigKey(java.lang.String name,
                                               java.lang.String description)

newIntegerConfigKey

public static ConfigKey<java.lang.Integer> newIntegerConfigKey(java.lang.String name,
                                               java.lang.String description,
                                               java.lang.Integer defaultValue)

newLongConfigKey

public static ConfigKey<java.lang.Long> newLongConfigKey(java.lang.String name)

newLongConfigKey

public static ConfigKey<java.lang.Long> newLongConfigKey(java.lang.String name,
                                         java.lang.String description)

newLongConfigKey

public static ConfigKey<java.lang.Long> newLongConfigKey(java.lang.String name,
                                         java.lang.String description,
                                         java.lang.Long defaultValue)

newDoubleConfigKey

public static ConfigKey<java.lang.Double> newDoubleConfigKey(java.lang.String name)

newDoubleConfigKey

public static ConfigKey<java.lang.Double> newDoubleConfigKey(java.lang.String name,
                                             java.lang.String description)

newDoubleConfigKey

public static ConfigKey<java.lang.Double> newDoubleConfigKey(java.lang.String name,
                                             java.lang.String description,
                                             java.lang.Double defaultValue)

newBooleanConfigKey

public static ConfigKey<java.lang.Boolean> newBooleanConfigKey(java.lang.String name)

newBooleanConfigKey

public static ConfigKey<java.lang.Boolean> newBooleanConfigKey(java.lang.String name,
                                               java.lang.String description)

newBooleanConfigKey

public static ConfigKey<java.lang.Boolean> newBooleanConfigKey(java.lang.String name,
                                               java.lang.String description,
                                               java.lang.Boolean defaultValue)

newDurationConfigKey

public static ConfigKey<Duration> newDurationConfigKey(java.lang.String name)

newDurationConfigKey

public static ConfigKey<Duration> newDurationConfigKey(java.lang.String name,
                                       java.lang.String description)

newDurationConfigKey

public static ConfigKey<Duration> newDurationConfigKey(java.lang.String name,
                                       java.lang.String description,
                                       Duration defaultValue)

Class ConfigKeys

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfigKeys

Method Detail

newConfigKey

newConfigKey

newConfigKey

newConfigKey

newConfigKey

newConfigKey

newSensorAndConfigKey

newSensorAndConfigKey

newSensorAndConfigKey

newSensorAndConfigKey

newStringSensorAndConfigKey

newStringSensorAndConfigKey

newIntegerSensorAndConfigKey

newIntegerSensorAndConfigKey

newPortSensorAndConfigKey

newPortSensorAndConfigKey

newConfigKey

builder

builder

newConfigKeyWithDefault

newConfigKeyWithDefault

newConfigKeyRenamed

newConfigKeyWithPrefix

convert

newStringConfigKey

newStringConfigKey

newStringConfigKey

newIntegerConfigKey

newIntegerConfigKey

newIntegerConfigKey

newLongConfigKey

newLongConfigKey

newLongConfigKey

newDoubleConfigKey

newDoubleConfigKey

newDoubleConfigKey

newBooleanConfigKey

newBooleanConfigKey

newBooleanConfigKey

newDurationConfigKey

newDurationConfigKey

newDurationConfigKey