Overview  Package   Class  Deprecated  Index  Help 
Brooklyn
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

brooklyn.event.basic
[Java] Class BasicConfigKey

java.lang.Object
  brooklyn.event.basic.BasicConfigKey
All Implemented Interfaces:
ConfigKeySelfExtracting, java.io.Serializable
public class BasicConfigKey
Nested Class Summary
static class BasicConfigKey.BasicConfigKeyOverwriting

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

 
Method Summary
java.lang.Object BasicConfigKey()

java.lang.Object BasicConfigKey(java.lang.Class type, java.lang.String name)

java.lang.Object BasicConfigKey(java.lang.Class type, java.lang.String name, java.lang.String description)

java.lang.Object BasicConfigKey(java.lang.Class type, java.lang.String name, java.lang.String description, java.lang.Object defaultValue)

java.lang.Object BasicConfigKey(TypeToken type, java.lang.String name)

java.lang.Object BasicConfigKey(TypeToken type, java.lang.String name, java.lang.String description)

java.lang.Object BasicConfigKey(TypeToken type, java.lang.String name, java.lang.String description, java.lang.Object defaultValue)

java.lang.Object BasicConfigKey(ConfigKey key, java.lang.Object defaultValue)

@deprecated since 0.6.0; use ConfigKeys#newConfigKeyWithDefault(ConfigKey, Object)#newConfigKeyWithDefault(ConfigKey, Object)
protected java.lang.Object BasicConfigKey(BasicConfigKey.Builder builder)

static BasicConfigKey.Builder builder(TypeToken type)

static BasicConfigKey.Builder builder(java.lang.Class type)

boolean equals(java.lang.Object obj)

java.lang.Object extractValue(java.util.Map vals, ExecutionContext exec)

Retrieves the value corresponding to this config key from the given map.

java.lang.Object getDefaultValue()

@see ConfigKey#getDefaultValue()
java.lang.String getDescription()

@see ConfigKey#getDescription()
java.lang.String getName()

@see ConfigKey#getName()
java.util.Collection getNameParts()

@see ConfigKey#getNameParts()
java.lang.Class getType()

@see ConfigKey#getType()
java.lang.String getTypeName()

@see ConfigKey#getTypeName()
TypeToken getTypeToken()

@see ConfigKey#getTypeToken()
boolean hasDefaultValue()

@see ConfigKey#hasDefaultValue()
int hashCode()

boolean isReconfigurable()

boolean isSet(java.util.Map vals)

protected java.lang.Object resolveValue(java.lang.Object v, ExecutionContext exec)

java.lang.String toString()

 
Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Method Detail

BasicConfigKey

public java.lang.Object BasicConfigKey()

BasicConfigKey

public java.lang.Object BasicConfigKey(java.lang.Class type, java.lang.String name)

BasicConfigKey

public java.lang.Object BasicConfigKey(java.lang.Class type, java.lang.String name, java.lang.String description)

BasicConfigKey

public java.lang.Object BasicConfigKey(java.lang.Class type, java.lang.String name, java.lang.String description, java.lang.Object defaultValue)

BasicConfigKey

public java.lang.Object BasicConfigKey(TypeToken type, java.lang.String name)

BasicConfigKey

public java.lang.Object BasicConfigKey(TypeToken type, java.lang.String name, java.lang.String description)

BasicConfigKey

public java.lang.Object BasicConfigKey(TypeToken type, java.lang.String name, java.lang.String description, java.lang.Object defaultValue)

BasicConfigKey

public java.lang.Object BasicConfigKey(ConfigKey key, java.lang.Object defaultValue)
deprecated:
since 0.6.0; use ConfigKeys#newConfigKeyWithDefault(ConfigKey, Object)#newConfigKeyWithDefault(ConfigKey, Object)

BasicConfigKey

protected java.lang.Object BasicConfigKey(BasicConfigKey.Builder builder)

builder

@Beta
public static BasicConfigKey.Builder builder(TypeToken type)

builder

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

equals

public boolean equals(Object obj) {
public boolean equals(java.lang.Object obj)

extractValue

@Override
public T extractValue(Map vals, ExecutionContext exec) {
public java.lang.Object 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.

getDefaultValue

public java.lang.Object getDefaultValue()
See Also:
ConfigKey#getDefaultValue()#getDefaultValue()

getDescription

public java.lang.String getDescription()
See Also:
ConfigKey#getDescription()#getDescription()

getName

public java.lang.String getName()
See Also:
ConfigKey#getName()#getName()

getNameParts

return
public java.util.Collection getNameParts()
See Also:
ConfigKey#getNameParts()#getNameParts()

getType

public java.lang.Class getType()
See Also:
ConfigKey#getType()#getType()

getTypeName

public java.lang.String getTypeName()
See Also:
ConfigKey#getTypeName()#getTypeName()

getTypeToken

public TypeToken getTypeToken()
See Also:
ConfigKey#getTypeToken()#getTypeToken()

hasDefaultValue

return
public boolean hasDefaultValue()
See Also:
ConfigKey#hasDefaultValue()#hasDefaultValue()

hashCode

public int hashCode() {
public int hashCode()

isReconfigurable

public boolean isReconfigurable() {
public boolean isReconfigurable()

isSet

public boolean isSet(Map vals) {
public boolean isSet(java.util.Map vals)

resolveValue

protected java.lang.Object resolveValue(java.lang.Object v, ExecutionContext exec)

toString

public String toString() {
public java.lang.String toString()

 

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.