EntityConfigMap (Apache Brooklyn)

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

All Implemented Interfaces:: ConfigMap

public class EntityConfigMap
extends java.lang.Object
implements ConfigMap

Constructor Summary

Constructors
Constructor and Description

EntityConfigMap(AbstractEntity entity, java.util.Map<ConfigKey<?>,java.lang.Object> storage)

Constructors
Constructor and Description
`EntityConfigMap(AbstractEntity entity, java.util.Map<ConfigKey<?>,java.lang.Object> storage)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addToLocalBag(java.util.Map<java.lang.String,?> vals)`
`java.util.Map<java.lang.String,java.lang.Object>`	`asMapWithStringKeys()` returns a read-only map view which has string keys (corresponding to the config key names); callers encouraged to use the typed keys (and so not use this method), but in some compatibility areas having a Properties-like view is useful
`void`	`clearInheritedConfig()`
`java.util.Map<ConfigKey<?>,java.lang.Object>`	`getAllConfig()` an immutable copy of the config visible at this entity, local and inherited (preferring local)
`ConfigBag`	`getAllConfigBag()` Creates an immutable copy of the config visible at this entity, local and inherited (preferring local), including those that did not match config keys
`<T> T`	`getConfig(ConfigKey.HasConfigKey<T> key)`
`<T> T`	`getConfig(ConfigKey.HasConfigKey<T> key, T defaultValue)`
`<T> T`	`getConfig(ConfigKey<T> key)`
`<T> T`	`getConfig(ConfigKey<T> key, T defaultValue)` returns value stored against the given key, resolved (if it is a Task, possibly blocking), and coerced to the appropriate type, or given default value if not set, unless the default value is null in which case it returns the default
`Maybe<java.lang.Object>`	`getConfigRaw(ConfigKey<?> key, boolean includeInherited)` returns the value stored against the given key, not any default, not resolved (and guaranteed non-blocking) and not type-coerced
`java.util.Map<ConfigKey<?>,java.lang.Object>`	`getLocalConfig()` an immutable copy of the config defined at this entity, ie not inherited
`ConfigBag`	`getLocalConfigBag()` Creates an immutable copy of the config defined at this entity, ie not inherited, including those that did not match config keys
`java.lang.Object`	`getRawConfig(ConfigKey<?> key)` Deprecated.
`boolean`	`isEmpty()`
`java.lang.Object`	`setConfig(ConfigKey<?> key, java.lang.Object v)`
`void`	`setInheritedConfig(java.util.Map<ConfigKey<?>,? extends java.lang.Object> vals, ConfigBag configBagVals)`
`void`	`setLocalConfig(java.util.Map<ConfigKey<?>,? extends java.lang.Object> vals)`
`int`	`size()`
`EntityConfigMap`	`submap(com.google.common.base.Predicate<ConfigKey<?>> filter)` returns submap matching the given filter predicate; see ConfigPredicates for common predicates
`java.lang.String`	`toString()`

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

- Constructor Detail
  - EntityConfigMap
```
public EntityConfigMap(AbstractEntity entity,
               java.util.Map<ConfigKey<?>,java.lang.Object> storage)
```
- Method Detail
  - getConfig
```
public <T> T getConfig(ConfigKey<T> key)
```
    Specified by:
    
    getConfig in interface ConfigMap
    
    See Also:
    #getConfig(ConfigKey, Object), with default value as per the key, or null
  - getConfig
```
public <T> T getConfig(ConfigKey.HasConfigKey<T> key)
```
    Specified by:
    
    getConfig in interface ConfigMap
    
    See Also:
    #getConfig(ConfigKey, Object), with default value as per the key, or null
  - getConfig
```
public <T> T getConfig(ConfigKey.HasConfigKey<T> key,
              T defaultValue)
```
    Specified by:
    
    getConfig in interface ConfigMap
    
    See Also:
    #getConfig(ConfigKey, Object), with provided default value if not set
  - getConfig
```
public <T> T getConfig(ConfigKey<T> key,
              T defaultValue)
```
    Description copied from interface: ConfigMap
    
    returns value stored against the given key, resolved (if it is a Task, possibly blocking), and coerced to the appropriate type, or given default value if not set, unless the default value is null in which case it returns the default
    
    Specified by:
    
    getConfig in interface ConfigMap
  - getRawConfig
```
@Deprecated
public java.lang.Object getRawConfig(ConfigKey<?> key)
```
    Deprecated.
    
    Description copied from interface: ConfigMap
    
    as #getConfigRaw(ConfigKey) but returning null if not present
    
    Specified by:
    
    getRawConfig in interface ConfigMap
  - getConfigRaw
```
public Maybe<java.lang.Object> getConfigRaw(ConfigKey<?> key,
                                   boolean includeInherited)
```
    Description copied from interface: ConfigMap
    
    returns the value stored against the given key, not any default, not resolved (and guaranteed non-blocking) and not type-coerced
    
    Specified by:
    
    getConfigRaw in interface ConfigMap
    
    Parameters:
    key - key to look up
    includeInherited - for ConfigMap instances which have an inheritance hierarchy, whether to traverse it or not; has no effects where there is no inheritance
    
    Returns:
    raw, unresolved, uncoerced value of key in map, but not any default on the key
  - getAllConfig
```
public java.util.Map<ConfigKey<?>,java.lang.Object> getAllConfig()
```
    an immutable copy of the config visible at this entity, local and inherited (preferring local)
    
    Specified by:
    
    getAllConfig in interface ConfigMap
  - getLocalConfig
```
public java.util.Map<ConfigKey<?>,java.lang.Object> getLocalConfig()
```
    an immutable copy of the config defined at this entity, ie not inherited
  - getAllConfigBag
```
public ConfigBag getAllConfigBag()
```
    Creates an immutable copy of the config visible at this entity, local and inherited (preferring local), including those that did not match config keys
  - getLocalConfigBag
```
public ConfigBag getLocalConfigBag()
```
    Creates an immutable copy of the config defined at this entity, ie not inherited, including those that did not match config keys
  - setConfig
```
public java.lang.Object setConfig(ConfigKey<?> key,
                         java.lang.Object v)
```
  - setLocalConfig
```
public void setLocalConfig(java.util.Map<ConfigKey<?>,? extends java.lang.Object> vals)
```
  - setInheritedConfig
```
public void setInheritedConfig(java.util.Map<ConfigKey<?>,? extends java.lang.Object> vals,
                      ConfigBag configBagVals)
```
  - addToLocalBag
```
public void addToLocalBag(java.util.Map<java.lang.String,?> vals)
```
  - clearInheritedConfig
```
public void clearInheritedConfig()
```
  - submap
```
public EntityConfigMap submap(com.google.common.base.Predicate<ConfigKey<?>> filter)
```
    Description copied from interface: ConfigMap
    
    returns submap matching the given filter predicate; see ConfigPredicates for common predicates
    
    Specified by:
    
    submap in interface ConfigMap
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - asMapWithStringKeys
```
public java.util.Map<java.lang.String,java.lang.Object> asMapWithStringKeys()
```
    Description copied from interface: ConfigMap
    
    returns a read-only map view which has string keys (corresponding to the config key names); callers encouraged to use the typed keys (and so not use this method), but in some compatibility areas having a Properties-like view is useful
    
    Specified by:
    
    asMapWithStringKeys in interface ConfigMap
  - size
```
public int size()
```
    Specified by:
    
    size in interface ConfigMap
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface ConfigMap

Class EntityConfigMap

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EntityConfigMap

Method Detail

getConfig

getConfig

getConfig

getConfig

getRawConfig

getConfigRaw

getAllConfig

getLocalConfig

getAllConfigBag

getLocalConfigBag

setConfig

setLocalConfig

setInheritedConfig

addToLocalBag

clearInheritedConfig

submap

toString

asMapWithStringKeys

size

isEmpty