AbstractConfigurationSupportInternal (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.core.objs.AbstractConfigurationSupportInternal

All Implemented Interfaces:

Configurable.ConfigurationSupport, BrooklynObjectInternal.ConfigurationSupportInternal

Direct Known Subclasses:

AbstractEntity.BasicConfigurationSupport
```
public abstract class AbstractConfigurationSupportInternal
extends java.lang.Object
implements BrooklynObjectInternal.ConfigurationSupportInternal
```

Constructor Summary

Constructors
Constructor and Description

AbstractConfigurationSupportInternal()

Constructors
Constructor and Description
`AbstractConfigurationSupportInternal()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.util.Set<ConfigKey<?>>`	`findKeys(<any> filter)` Deprecated.
`java.util.Set<ConfigKey<?>>`	`findKeysDeclared(<any> filter)` see `ConfigMap#findKeysDeclared(Predicate)`
`java.util.Set<ConfigKey<?>>`	`findKeysPresent(<any> filter)` see `ConfigMap#findKeysPresent(Predicate)`
`<T> T`	`get(ConfigKey.HasConfigKey<T> key)`
`<T> T`	`get(ConfigKey<T> key)` Gets the given configuration value for this entity, in the following order of precedence: value (including null) explicitly set on the entity value (including null) explicitly set on an ancestor (inherited) a default value (including null) on the best equivalent static key of the same name declared on the entity (where best equivalence is defined as preferring a config key which extends another, as computed in EntityDynamicType.getConfigKeys) a default value (including null) on the key itself null
`java.util.Map<ConfigKey<?>,java.lang.Object>`	`getAllLocalRaw()` Returns all config defined here, in `BrooklynObjectInternal.ConfigurationSupportInternal.getLocalRaw(ConfigKey)` format
`ConfigBag`	`getBag()` Returns a read-only view of all the config key/value pairs on this entity, backed by a string-based map, including config names that did not match anything on this entity.
`ConfigMap.ConfigMapWithInheritance<? extends BrooklynObject>`	`getInternalConfigMap()` This is currently the only way to get some rolled up collections and raw, and also to test for the presence of a value (without any default).
`ConfigBag`	`getLocalBag()` Returns a read-only view of the local (i.e.
`Maybe<java.lang.Object>`	`getLocalRaw(ConfigKey.HasConfigKey<?> key)`
`Maybe<java.lang.Object>`	`getLocalRaw(ConfigKey<?> key)` Returns the uncoerced value for this config key, if available, not following any inheritance chains and not taking any default.
`<T> Maybe<T>`	`getNonBlocking(ConfigKey.HasConfigKey<T> key)`
`<T> Maybe<T>`	`getNonBlocking(ConfigKey<T> key)` Attempts to coerce the value for this config key, if available, including returning a default if the config key is unset, returning a `absent` if the uncoerced does not support immediate resolution.
`Maybe<java.lang.Object>`	`getRaw(ConfigKey.HasConfigKey<?> key)`
`Maybe<java.lang.Object>`	`getRaw(ConfigKey<?> key)` Returns the uncoerced value for this config key, if available, not taking any default.
`void`	`putAll(java.util.Map<?,?> vals)` Adds keys or strings, making anonymous keys from strings; throws on other keys
`void`	`removeAllLocalConfig()` Clears all local config, e.g.
`void`	`removeKey(ConfigKey<?> key)`
`void`	`removeKey(java.lang.String key)`
`<T> T`	`set(ConfigKey.HasConfigKey<T> key, T val)`
`<T> T`	`set(ConfigKey.HasConfigKey<T> key, Task<T> val)`
`<T> T`	`set(ConfigKey<T> key, T val)` Sets the config to the given value.
`<T> T`	`set(ConfigKey<T> key, Task<T> val)` Sets the config to the value returned by the task.
`void`	`set(java.util.Map<?,?> vals)` Deprecated.

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

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal.ConfigurationSupportInternal
refreshInheritedConfig, refreshInheritedConfigOfChildren

- Constructor Detail
  - AbstractConfigurationSupportInternal
```
public AbstractConfigurationSupportInternal()
```
- Method Detail
  - get
```
public <T> T get(ConfigKey.HasConfigKey<T> key)
```
    Specified by:
    
    get in interface Configurable.ConfigurationSupport
    
    See Also:
    
    #get(ConfigKey)}
  - getLocalRaw
```
public Maybe<java.lang.Object> getLocalRaw(ConfigKey.HasConfigKey<?> key)
```
    Specified by:
    
    getLocalRaw in interface BrooklynObjectInternal.ConfigurationSupportInternal
    
    See Also:
    
    #getLocalRaw(ConfigKey)}
  - getRaw
```
public Maybe<java.lang.Object> getRaw(ConfigKey.HasConfigKey<?> key)
```
    Specified by:
    
    getRaw in interface BrooklynObjectInternal.ConfigurationSupportInternal
    
    See Also:
    
    #getRaw(ConfigKey)}
  - getNonBlocking
```
public <T> Maybe<T> getNonBlocking(ConfigKey.HasConfigKey<T> key)
```
    Specified by:
    
    getNonBlocking in interface BrooklynObjectInternal.ConfigurationSupportInternal
    
    See Also:
    
    #getNonBlocking(ConfigKey)}
  - getNonBlocking
```
public <T> Maybe<T> getNonBlocking(ConfigKey<T> key)
```
    Description copied from interface: BrooklynObjectInternal.ConfigurationSupportInternal
    
    Attempts to coerce the value for this config key, if available, including returning a default if the config key is unset, returning a absent if the uncoerced does not support immediate resolution. This also returns absent if the value or default value cannot be coerced to the type required by the key, with coercion errors typically handled when setting or when getting the "really needed" values, not when validating constraints which is one of the main use cases of this method.
    Note: if no value for the key is available, not even as a default, this returns a Maybe.isPresent() containing null (following the semantics of Configurable.ConfigurationSupport.get(ConfigKey) rather than BrooklynObjectInternal.ConfigurationSupportInternal.getRaw(ConfigKey)). Thus a Maybe.absent() definitively indicates that the absence is due to the request to evaluate immediately.
    This will include catching ImmediateSupplier.ImmediateUnsupportedException and returning it as an absence, thus making the semantics here slightly "safer" than that of ImmediateSupplier.getImmediately().
    
    Specified by:
    
    getNonBlocking in interface BrooklynObjectInternal.ConfigurationSupportInternal
  - set
```
public <T> T set(ConfigKey.HasConfigKey<T> key,
                 Task<T> val)
```
    Specified by:
    
    set in interface Configurable.ConfigurationSupport
    
    See Also:
    
    #set(ConfigKey, Task)}
  - set
```
public <T> T set(ConfigKey.HasConfigKey<T> key,
                 T val)
```
    Specified by:
    
    set in interface Configurable.ConfigurationSupport
    
    See Also:
    
    #set(ConfigKey, Object)}
  - get
```
public <T> T get(ConfigKey<T> key)
```
    Description copied from interface: Configurable.ConfigurationSupport
    Gets the given configuration value for this entity, in the following order of precedence:
    1. value (including null) explicitly set on the entity
    2. value (including null) explicitly set on an ancestor (inherited)
    3. a default value (including null) on the best equivalent static key of the same name declared on the entity (where best equivalence is defined as preferring a config key which extends another, as computed in EntityDynamicType.getConfigKeys)
    4. a default value (including null) on the key itself
    5. null
    Specified by:
    
    get in interface Configurable.ConfigurationSupport
  - set
```
public <T> T set(ConfigKey<T> key,
                 T val)
```
    Description copied from interface: Configurable.ConfigurationSupport
    
    Sets the config to the given value.
    
    Specified by:
    
    set in interface Configurable.ConfigurationSupport
  - set
```
public <T> T set(ConfigKey<T> key,
                 Task<T> val)
```
    Description copied from interface: Configurable.ConfigurationSupport
    
    Sets the config to the value returned by the task. Returns immediately without blocking; subsequent calls to Configurable.getConfig(ConfigKey) will execute the task, and block until the task completes.
    
    Specified by:
    
    set in interface Configurable.ConfigurationSupport
  - getLocalBag
```
public ConfigBag getLocalBag()
```
    Description copied from interface: BrooklynObjectInternal.ConfigurationSupportInternal
    
    Returns a read-only view of the local (i.e. not inherited) config key/value pairs on this entity, backed by a string-based map, including config names that did not match anything on this entity.
    
    Specified by:
    
    getLocalBag in interface BrooklynObjectInternal.ConfigurationSupportInternal
  - getRaw
```
public Maybe<java.lang.Object> getRaw(ConfigKey<?> key)
```
    Description copied from interface: BrooklynObjectInternal.ConfigurationSupportInternal
    
    Returns the uncoerced value for this config key, if available, not taking any default. If there is no local value and there is an explicit inherited value, will return the inherited. May return a Maybe-wrapped null if the value is explicitly null. Returns Maybe.absent() if the key is not explicitly set on this object or an ancestor. Often this is used with Maybe#or(Object)) to return default value.
    See also {@link #getLocalRaw(ConfigKey).
    
    Specified by:
    
    getRaw in interface BrooklynObjectInternal.ConfigurationSupportInternal
  - getLocalRaw
```
public Maybe<java.lang.Object> getLocalRaw(ConfigKey<?> key)
```
    Description copied from interface: BrooklynObjectInternal.ConfigurationSupportInternal
    
    Returns the uncoerced value for this config key, if available, not following any inheritance chains and not taking any default. Returns Maybe.absent() if the key is not explicitly set on this object.
    See also {@link #getRaw(ConfigKey).
    
    Specified by:
    
    getLocalRaw in interface BrooklynObjectInternal.ConfigurationSupportInternal
  - putAll
```
public void putAll(java.util.Map<?,?> vals)
```
    Description copied from interface: BrooklynObjectInternal.ConfigurationSupportInternal
    
    Adds keys or strings, making anonymous keys from strings; throws on other keys
    
    Specified by:
    
    putAll in interface BrooklynObjectInternal.ConfigurationSupportInternal
  - set
```
@Deprecated
public void set(java.util.Map<?,?> vals)
```
    Deprecated.
    
    Specified by:
    
    set in interface BrooklynObjectInternal.ConfigurationSupportInternal
  - removeKey
```
public void removeKey(java.lang.String key)
```
    Specified by:
    
    removeKey in interface BrooklynObjectInternal.ConfigurationSupportInternal
  - removeKey
```
public void removeKey(ConfigKey<?> key)
```
    Specified by:
    
    removeKey in interface BrooklynObjectInternal.ConfigurationSupportInternal
  - removeAllLocalConfig
```
public void removeAllLocalConfig()
```
    Description copied from interface: BrooklynObjectInternal.ConfigurationSupportInternal
    
    Clears all local config, e.g. on tear-down
    
    Specified by:
    
    removeAllLocalConfig in interface BrooklynObjectInternal.ConfigurationSupportInternal
  - findKeys
```
@Deprecated
public java.util.Set<ConfigKey<?>> findKeys(<any> filter)
```
    Deprecated.
    
    Specified by:
    
    findKeys in interface Configurable.ConfigurationSupport
  - findKeysDeclared
```
public java.util.Set<ConfigKey<?>> findKeysDeclared(<any> filter)
```
    Description copied from interface: Configurable.ConfigurationSupport
    
    see ConfigMap#findKeysDeclared(Predicate)
    
    Specified by:
    
    findKeysDeclared in interface Configurable.ConfigurationSupport
  - findKeysPresent
```
public java.util.Set<ConfigKey<?>> findKeysPresent(<any> filter)
```
    Description copied from interface: Configurable.ConfigurationSupport
    
    see ConfigMap#findKeysPresent(Predicate)
    
    Specified by:
    
    findKeysPresent in interface Configurable.ConfigurationSupport
  - getInternalConfigMap
```
public ConfigMap.ConfigMapWithInheritance<? extends BrooklynObject> getInternalConfigMap()
```
    Description copied from interface: BrooklynObjectInternal.ConfigurationSupportInternal
    
    This is currently the only way to get some rolled up collections and raw, and also to test for the presence of a value (without any default). As more accessors are added callers may be asked to migrate. Callers may also consider using #findKeysDeclared(com.google.common.base.Predicate) although efficiency should be considered (this gives direct access whereas that does lookups and copies).
    
    Specified by:
    
    getInternalConfigMap in interface BrooklynObjectInternal.ConfigurationSupportInternal
  - getAllLocalRaw
```
public java.util.Map<ConfigKey<?>,java.lang.Object> getAllLocalRaw()
```
    Description copied from interface: BrooklynObjectInternal.ConfigurationSupportInternal
    
    Returns all config defined here, in BrooklynObjectInternal.ConfigurationSupportInternal.getLocalRaw(ConfigKey) format
    
    Specified by:
    
    getAllLocalRaw in interface BrooklynObjectInternal.ConfigurationSupportInternal
  - getBag
```
public ConfigBag getBag()
```
    Description copied from interface: BrooklynObjectInternal.ConfigurationSupportInternal
    
    Returns a read-only view of all the config key/value pairs on this entity, backed by a string-based map, including config names that did not match anything on this entity. This method gives no information about which config is inherited versus local; this means ConfigKey.getInheritanceByContext() cannot be respected if an anonymous key (not matching a declared config key) is set but the strongly typed key is accessed.
    It does not identify the container where it is defined, meaning URLs and deferred config values cannot be resolved in the context of the appropriate ancestor.
    For these reasons it is recommended to use a different accessor, and callers should be advised this beta method may be removed.
    
    Specified by:
    
    getBag in interface BrooklynObjectInternal.ConfigurationSupportInternal

Class AbstractConfigurationSupportInternal

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal.ConfigurationSupportInternal

Constructor Detail

AbstractConfigurationSupportInternal

Method Detail

get

getLocalRaw

getRaw

getNonBlocking

getNonBlocking

set

set

get

set

set

getLocalBag

getRaw

getLocalRaw

putAll

set

removeKey

removeKey

removeAllLocalConfig

findKeys

findKeysDeclared

findKeysPresent

getInternalConfigMap

getAllLocalRaw

getBag