AbstractConfigMapImpl (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.core.config.internal.AbstractConfigMapImpl<TContainer>

All Implemented Interfaces:: ConfigMap, ConfigMap.ConfigMapWithInheritance<TContainer>

Direct Known Subclasses:: AdjunctConfigMap, EntityConfigMap, LocationConfigMap

public abstract class AbstractConfigMapImpl<TContainer extends BrooklynObject>
extends java.lang.Object
implements ConfigMap.ConfigMapWithInheritance<TContainer>

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.brooklyn.config.ConfigMap
  ConfigMap.ConfigMapWithInheritance<TContainer>

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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
`java.util.Set<ConfigKey<?>>`	`findKeys(com.google.common.base.Predicate<? super ConfigKey<?>> filter)` returns all keys matching the given filter predicate; see ConfigPredicates for common predicates
`java.util.Map<ConfigKey<?>,java.lang.Object>`	`getAllConfig()` Deprecated.
`ConfigBag`	`getAllConfigBag()` Deprecated.
`java.util.Map<ConfigKey<?>,java.lang.Object>`	`getAllConfigInheritedRawValuesIgnoringErrors()` as `ConfigMap.ConfigMapWithInheritance.getAllConfigInheritedRawWithErrors()` but simplified API, just giving values, ignoring any errors
`java.util.Map<ConfigKey<?>,ReferenceWithError<ConfigValueAtContainer<TContainer,?>>>`	`getAllConfigInheritedRawWithErrors()` returns a read-only map of all config keys local and inherited together with best-effort raw values as per `ConfigMap.ConfigMapWithInheritance.getConfigAllInheritedRaw(ConfigKey)`
`java.util.Map<ConfigKey<?>,java.lang.Object>`	`getAllConfigLocalRaw()` returns a read-only map of all local config keys with their raw (unresolved+uncoerced) contents
`java.util.Map<ConfigKey<?>,ReferenceWithError<ConfigValueAtContainer<TContainer,?>>>`	`getAllReinheritableConfigRaw()` as `#getAllConfigInheritedRaw()` but removes any entries which should not be re-inheritable by descendants
`<T> T`	`getConfig(ConfigKey.HasConfigKey<T> key)`
`<T> T`	`getConfig(ConfigKey<T> key)`
`java.util.List<ConfigValueAtContainer<TContainer,?>>`	`getConfigAllInheritedRaw(ConfigKey<?> queryKey)` As `ConfigMap.getConfigLocalRaw(ConfigKey)` but returning all containers through the inheritance hierarchy where a value is set (but stopping if it encounters a key is not inheritable from a container).
`<T> ReferenceWithError<ConfigValueAtContainer<TContainer,T>>`	`getConfigAndContainer(ConfigKey<T> key)` Returns the container where a given key is defined, in addition to the value and data on the key it is defined against, wrapped in something which will report any error during evaluation (in some cases these errors may otherwise be silently ignored)
`ReferenceWithError<ConfigValueAtContainer<TContainer,?>>`	`getConfigInheritedRaw(ConfigKey<?> key)` As `ConfigMap.getConfigLocalRaw(ConfigKey)` but respecting the inheritance rules.
`Maybe<java.lang.Object>`	`getConfigLocalRaw(ConfigKey<?> key)` returns the value stored against the given key, not any default, not inherited (if there is an inheritance hierarchy), not type-coerced or further resolved (eg a task or supplier, if such rules are applicable)
`Maybe<java.lang.Object>`	`getConfigRaw(ConfigKey<?> key, boolean includeInherited)` Deprecated.
`TContainer`	`getContainer()`
`ConfigBag`	`getLocalConfigBag()` As `#getLocalConfigRaw()` but in a `ConfigBag` for convenience
`boolean`	`isEmpty()`
`void`	`putAll(java.util.Map<?,?> vals)`
`void`	`removeKey(ConfigKey<?> key)`
`void`	`removeKey(java.lang.String key)`
`java.lang.Object`	`setConfig(ConfigKey<?> key, java.lang.Object v)`
`void`	`setLocalConfig(java.util.Map<ConfigKey<?>,?> vals)`
`int`	`size()`
`java.lang.String`	`toString()`

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

Methods inherited from interface org.apache.brooklyn.config.ConfigMap
submap

- Method Detail
  - getContainer
```
public TContainer getContainer()
```
  - 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
  - getConfigLocalRaw
```
public Maybe<java.lang.Object> getConfigLocalRaw(ConfigKey<?> key)
```
    Description copied from interface: ConfigMap
    
    returns the value stored against the given key, not any default, not inherited (if there is an inheritance hierarchy), not type-coerced or further resolved (eg a task or supplier, if such rules are applicable)
    
    Specified by:
    
    getConfigLocalRaw in interface ConfigMap
    
    Parameters:
    
    key - key to look up
    
    Returns:
    
    raw, unresolved, uncoerced value of key explicitly in map
  - getAllConfigLocalRaw
```
public java.util.Map<ConfigKey<?>,java.lang.Object> getAllConfigLocalRaw()
```
    Description copied from interface: ConfigMap
    
    returns a read-only map of all local config keys with their raw (unresolved+uncoerced) contents
    
    Specified by:
    
    getAllConfigLocalRaw in interface ConfigMap
  - getAllConfig
```
@Deprecated
public java.util.Map<ConfigKey<?>,java.lang.Object> getAllConfig()
```
    Deprecated.
    
    an immutable copy of the config visible at this entity, local and inherited (preferring local)
    
    Specified by:
    
    getAllConfig in interface ConfigMap
  - getAllConfigBag
```
@Deprecated
public ConfigBag getAllConfigBag()
```
    Deprecated.
    
    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()
```
    As #getLocalConfigRaw() but in a ConfigBag for convenience
  - setConfig
```
public java.lang.Object setConfig(ConfigKey<?> key,
                                  java.lang.Object v)
```
  - setLocalConfig
```
public void setLocalConfig(java.util.Map<ConfigKey<?>,?> vals)
```
  - putAll
```
public void putAll(java.util.Map<?,?> vals)
```
  - removeKey
```
public void removeKey(java.lang.String key)
```
  - removeKey
```
public void removeKey(ConfigKey<?> key)
```
  - getConfigRaw
```
@Deprecated
public Maybe<java.lang.Object> getConfigRaw(ConfigKey<?> key,
                                                        boolean includeInherited)
```
    Deprecated.
    
    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
  - 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
  - getConfigAndContainer
```
public <T> ReferenceWithError<ConfigValueAtContainer<TContainer,T>> getConfigAndContainer(ConfigKey<T> key)
```
    Description copied from interface: ConfigMap.ConfigMapWithInheritance
    
    Returns the container where a given key is defined, in addition to the value and data on the key it is defined against, wrapped in something which will report any error during evaluation (in some cases these errors may otherwise be silently ignored)
    
    Specified by:
    
    getConfigAndContainer in interface ConfigMap.ConfigMapWithInheritance<TContainer extends BrooklynObject>
  - getConfigAllInheritedRaw
```
public java.util.List<ConfigValueAtContainer<TContainer,?>> getConfigAllInheritedRaw(ConfigKey<?> queryKey)
```
    Description copied from interface: ConfigMap.ConfigMapWithInheritance
    
    As ConfigMap.getConfigLocalRaw(ConfigKey) but returning all containers through the inheritance hierarchy where a value is set (but stopping if it encounters a key is not inheritable from a container).
    The list is in order with the highest ancestor first. Config inheritance strategies are not applied, apart from aborting ancestor traversal if inheritance of a key is blocked there.
    
    Specified by:
    
    getConfigAllInheritedRaw in interface ConfigMap.ConfigMapWithInheritance<TContainer extends BrooklynObject>
  - findKeys
```
public java.util.Set<ConfigKey<?>> findKeys(com.google.common.base.Predicate<? super ConfigKey<?>> filter)
```
    Description copied from interface: ConfigMap
    
    returns all keys matching the given filter predicate; see ConfigPredicates for common predicates
    
    Specified by:
    
    findKeys in interface ConfigMap
  - getConfigInheritedRaw
```
public ReferenceWithError<ConfigValueAtContainer<TContainer,?>> getConfigInheritedRaw(ConfigKey<?> key)
```
    Description copied from interface: ConfigMap.ConfigMapWithInheritance
    
    As ConfigMap.getConfigLocalRaw(ConfigKey) but respecting the inheritance rules. Because inheritance may not be applicable when working with raw values the result is wrapped in a ReferenceWithError, and if any aspect of inheritance could not be applied, calls to ReferenceWithError.get() will throw (but ReferenceWithError.getWithoutError() will not). Default values will be available from ConfigValueAtContainer.getDefaultValue() but will not be considered for ConfigValueAtContainer.get() or ConfigValueAtContainer.asMaybe().
    Note that most modes (eg overwrite, not-inherit) will not cause issues during inheritance so this method is ordinarily fine to use. Problems arise when a merge inheritance mode is specified and it is attempting to merge a raw value which is not mergeable.
    See also ConfigMap.ConfigMapWithInheritance.getConfigAllInheritedRaw(ConfigKey) which returns the complete set of inherited values.
    
    Specified by:
    
    getConfigInheritedRaw in interface ConfigMap.ConfigMapWithInheritance<TContainer extends BrooklynObject>
    
    Parameters:
    
    key - key to look up
  - getAllConfigInheritedRawValuesIgnoringErrors
```
public java.util.Map<ConfigKey<?>,java.lang.Object> getAllConfigInheritedRawValuesIgnoringErrors()
```
    Description copied from interface: ConfigMap.ConfigMapWithInheritance
    
    as ConfigMap.ConfigMapWithInheritance.getAllConfigInheritedRawWithErrors() but simplified API, just giving values, ignoring any errors
    
    Specified by:
    
    getAllConfigInheritedRawValuesIgnoringErrors in interface ConfigMap.ConfigMapWithInheritance<TContainer extends BrooklynObject>
  - getAllConfigInheritedRawWithErrors
```
public java.util.Map<ConfigKey<?>,ReferenceWithError<ConfigValueAtContainer<TContainer,?>>> getAllConfigInheritedRawWithErrors()
```
    Description copied from interface: ConfigMap.ConfigMapWithInheritance
    
    returns a read-only map of all config keys local and inherited together with best-effort raw values as per ConfigMap.ConfigMapWithInheritance.getConfigAllInheritedRaw(ConfigKey)
    
    Specified by:
    
    getAllConfigInheritedRawWithErrors in interface ConfigMap.ConfigMapWithInheritance<TContainer extends BrooklynObject>
  - getAllReinheritableConfigRaw
```
public java.util.Map<ConfigKey<?>,ReferenceWithError<ConfigValueAtContainer<TContainer,?>>> getAllReinheritableConfigRaw()
```
    Description copied from interface: ConfigMap.ConfigMapWithInheritance
    
    as #getAllConfigInheritedRaw() but removes any entries which should not be re-inheritable by descendants
    
    Specified by:
    
    getAllReinheritableConfigRaw in interface ConfigMap.ConfigMapWithInheritance<TContainer extends BrooklynObject>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class AbstractConfigMapImpl<TContainer extends BrooklynObject>

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.config.ConfigMap

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.brooklyn.config.ConfigMap

Method Detail

getContainer

getConfig

getConfig

getConfigLocalRaw

getAllConfigLocalRaw

getAllConfig

getAllConfigBag

getLocalConfigBag

setConfig

setLocalConfig

putAll

removeKey

removeKey

getConfigRaw

asMapWithStringKeys

size

isEmpty

getConfigAndContainer

getConfigAllInheritedRaw

findKeys

getConfigInheritedRaw

getAllConfigInheritedRawValuesIgnoringErrors

getAllConfigInheritedRawWithErrors

getAllReinheritableConfigRaw

toString