org.apache.brooklyn.config

Interface ConfigMap

All Known Subinterfaces:

BrooklynProperties, ConfigMap.ConfigMapWithInheritance<TContainer>, StringConfigMap

All Known Implementing Classes:

AbstractConfigMapImpl, AdjunctConfigMap, BrooklynPropertiesImpl, DeferredBrooklynProperties, EntityConfigMap, LocationConfigMap

public interface ConfigMap

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ConfigMap.ConfigMapWithInheritance<TContainer>

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	asMapWithStringKeys() Deprecated. since 0.10.0 use the corresponding methods to return ConfigKey-based maps, then pass to a ConfigBag to get a string-map view; kept for StringConfigMap
java.util.Set<ConfigKey<?>>	findKeys(<any> filter) Deprecated. since 0.11.0 use #findKeysDeclared(Predicate) or #findKeysPresent(Predicate) this method is like the above but it does not compare against reference keys in the container / type context. there are no known cases where that is the desired behaviour, so callers are being forced to migrate to one of the above other two methods. if keys in the map are needed and not the reference keys, let the brooklyn developers know to keep this functionality!
java.util.Set<ConfigKey<?>>	findKeysDeclared(<any> filter) returns all keys present in the map matching the given filter predicate; see ConfigPredicates for common predicates.
java.util.Set<ConfigKey<?>>	findKeysPresent(<any> filter) as #findKeysDeclared(Predicate) but restricted to keys actually present in the map
java.util.Map<ConfigKey<?>,java.lang.Object>	getAllConfig() Deprecated. since 0.10.0 in favour of getAllConfigLocalRaw() for local and ConfigMap.ConfigMapWithInheritance methods for inherited; kept on some sub-interfaces (eg Brooklyn properties)
java.util.Map<ConfigKey<?>,java.lang.Object>	getAllConfigLocalRaw() returns a read-only map of all local config keys with their raw (unresolved+uncoerced) contents
<T> T	getConfig(ConfigKey.HasConfigKey<T> key)
<T> T	getConfig(ConfigKey<T> key)
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. since 0.10.0 in favour of ConfigMap.ConfigMapWithInheritance methods
boolean	isEmpty()
int	size()
ConfigMap	submap(<any> filter) Deprecated. since 0.10.0 use #findKeys(Predicate) then do whatever is desired for the values; kept on StringConfigMap

Method Detail

getConfig

<T> T getConfig(ConfigKey<T> key)

See Also:

#getConfig(ConfigKey, Object), with default value as per the key, or null

getConfig

<T> T getConfig(ConfigKey.HasConfigKey<T> key)

See Also:

#getConfig(ConfigKey, Object), with default value as per the key, or null

getConfigRaw

@Deprecated
Maybe<java.lang.Object> getConfigRaw(ConfigKey<?> key,
                                                 boolean includeInherited)

Deprecated. since 0.10.0 in favour of ConfigMap.ConfigMapWithInheritance methods

returns the value stored against the given key, not any default, not resolved (and guaranteed non-blocking), and not type-coerced.

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

getConfigLocalRaw

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)

Parameters:

key - key to look up

Returns:

raw, unresolved, uncoerced value of key explicitly in map

getAllConfigLocalRaw

java.util.Map<ConfigKey<?>,java.lang.Object> getAllConfigLocalRaw()

returns a read-only map of all local config keys with their raw (unresolved+uncoerced) contents

getAllConfig

@Deprecated
java.util.Map<ConfigKey<?>,java.lang.Object> getAllConfig()

Deprecated. since 0.10.0 in favour of getAllConfigLocalRaw() for local and ConfigMap.ConfigMapWithInheritance methods for inherited; kept on some sub-interfaces (eg Brooklyn properties)

returns a map of all config keys to their raw (unresolved+uncoerced) contents

submap

@Deprecated
ConfigMap submap(<any> filter)

Deprecated. since 0.10.0 use #findKeys(Predicate) then do whatever is desired for the values; kept on StringConfigMap

returns submap matching the given filter predicate; see ConfigPredicates for common predicates

findKeys

@Deprecated
java.util.Set<ConfigKey<?>> findKeys(<any> filter)

Deprecated. since 0.11.0 use #findKeysDeclared(Predicate) or #findKeysPresent(Predicate)

this method is like the above but it does not compare against reference keys in the container / type context. there are no known cases where that is the desired behaviour, so callers are being forced to migrate to one of the above other two methods. if keys in the map are needed and not the reference keys, let the brooklyn developers know to keep this functionality!

findKeysDeclared

java.util.Set<ConfigKey<?>> findKeysDeclared(<any> filter)

returns all keys present in the map matching the given filter predicate; see ConfigPredicates for common predicates. if the map is associated with a container or type context where reference keys are defined, those keys are included in the result whether or not present in the map (unlike #findKeysPresent(Predicate))

findKeysPresent

java.util.Set<ConfigKey<?>> findKeysPresent(<any> filter)

as #findKeysDeclared(Predicate) but restricted to keys actually present in the map

if there is a container or type context defining reference keys, those key definitions will be preferred over any config keys used as keys in this map.

asMapWithStringKeys

@Deprecated
java.util.Map<java.lang.String,java.lang.Object> asMapWithStringKeys()

Deprecated. since 0.10.0 use the corresponding methods to return ConfigKey-based maps, then pass to a ConfigBag to get a string-map view; kept for StringConfigMap

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

size

int size()

isEmpty

boolean isEmpty()