org.apache.brooklyn.core.internal

Class BrooklynPropertiesImpl

java.lang.Object

org.apache.brooklyn.core.internal.BrooklynPropertiesImpl

All Implemented Interfaces:

ConfigMap, StringConfigMap, BrooklynProperties

public class BrooklynPropertiesImpl
extends java.lang.Object
implements BrooklynProperties

TODO methods in this class are not thread safe. intention is that they are set during startup and not modified thereafter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BrooklynPropertiesImpl.Factory

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

ConfigMap.ConfigMapWithInheritance<TContainer>

Method Summary

Modifier and Type	Method and Description
BrooklynPropertiesImpl	addEnvironmentVars()
BrooklynPropertiesImpl	addFrom(ConfigBag cfg)
BrooklynPropertiesImpl	addFrom(java.io.File f)
BrooklynPropertiesImpl	addFrom(java.io.InputStream i)
BrooklynPropertiesImpl	addFrom(java.util.Map map)
BrooklynPropertiesImpl	addFrom(java.net.URL u)
BrooklynPropertiesImpl	addFromMap(java.util.Map properties) adds the indicated properties
BrooklynPropertiesImpl	addFromUrl(java.lang.String url)
BrooklynPropertiesImpl	addFromUrlProperty(java.lang.String urlProperty) expects a property already set in scope, whose value is acceptable to addFromUrl(String); if property not set, does nothing
BrooklynPropertiesImpl	addSystemProperties()
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
boolean	containsKey(ConfigKey<?> key)
boolean	containsKey(java.lang.String key)
java.util.Set<ConfigKey<?>>	findKeys(<any> filter) Deprecated.
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.lang.String	get(java.util.Map flags, java.lang.String key) Deprecated. attempts to call get with this syntax are probably mistakes; get(key, defaultValue) is fine but Map is unlikely the key, much more likely they meant getFirst(flags, key).
java.util.Map<ConfigKey<?>,java.lang.Object>	getAllConfig() Deprecated.
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.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.
java.lang.Object	getConfig(java.lang.String 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)
Maybe<java.lang.Object>	getConfigRaw(ConfigKey<?> key, boolean includeInherited) Inheritance is ignored here.
java.lang.String	getFirst(java.util.Map flags, java.lang.String... keys) returns the value of the first key which is defined
java.lang.String	getFirst(java.lang.String... keys) returns the value of the first key which is defined
boolean	isEmpty()
<T> java.lang.Object	put(ConfigKey.HasConfigKey<T> key, T value)
<T> java.lang.Object	put(ConfigKey<T> key, T value)
java.lang.Object	put(java.lang.Object rawKey, java.lang.Object value) like normal map.put, except config keys are dereferenced on the way in
void	putAll(java.util.Map vals) like normal map.putAll, except config keys are dereferenced on the way in
<T> boolean	putIfAbsent(ConfigKey<T> key, T value)
boolean	putIfAbsent(java.lang.String key, java.lang.Object value) inserts the value under the given key, if it was not present
boolean	remove(ConfigKey<?> key)
boolean	remove(java.lang.String key)
int	size()
BrooklynProperties	submap(<any> filter) returns submap matching the given filter predicate; see ConfigPredicates for common predicates
BrooklynProperties	submapByName(<any> filter)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

addEnvironmentVars

public BrooklynPropertiesImpl addEnvironmentVars()

Specified by:

addEnvironmentVars in interface BrooklynProperties

addSystemProperties

public BrooklynPropertiesImpl addSystemProperties()

Specified by:

addSystemProperties in interface BrooklynProperties

addFrom

public BrooklynPropertiesImpl addFrom(ConfigBag cfg)

Specified by:

addFrom in interface BrooklynProperties

addFrom

public BrooklynPropertiesImpl addFrom(java.util.Map map)

Specified by:

addFrom in interface BrooklynProperties

addFrom

public BrooklynPropertiesImpl addFrom(java.io.InputStream i)

Specified by:

addFrom in interface BrooklynProperties

addFrom

public BrooklynPropertiesImpl addFrom(java.io.File f)

Specified by:

addFrom in interface BrooklynProperties

addFrom

public BrooklynPropertiesImpl addFrom(java.net.URL u)

Specified by:

addFrom in interface BrooklynProperties

addFromUrl

public BrooklynPropertiesImpl addFromUrl(java.lang.String url)

Specified by:

addFromUrl in interface BrooklynProperties

See Also:

of the form form file:///home/... or http:// or classpath://xx ; for convenience if not starting with xxx: it is treated as a classpath reference or a file; throws if not found (but does nothing if argument is null)

addFromUrlProperty

public BrooklynPropertiesImpl addFromUrlProperty(java.lang.String urlProperty)

expects a property already set in scope, whose value is acceptable to addFromUrl(String); if property not set, does nothing

Specified by:

addFromUrlProperty in interface BrooklynProperties

addFromMap

public BrooklynPropertiesImpl addFromMap(java.util.Map properties)

adds the indicated properties

Specified by:

addFromMap in interface BrooklynProperties

putIfAbsent

public boolean putIfAbsent(java.lang.String key,
                           java.lang.Object value)

inserts the value under the given key, if it was not present

Specified by:

putIfAbsent in interface BrooklynProperties

get

@Deprecated
public java.lang.String get(java.util.Map flags,
                                        java.lang.String key)

Deprecated. attempts to call get with this syntax are probably mistakes; get(key, defaultValue) is fine but Map is unlikely the key, much more likely they meant getFirst(flags, key).

Specified by:

get in interface BrooklynProperties

getFirst

public java.lang.String getFirst(java.lang.String... keys)

returns the value of the first key which is defined

takes the following flags: 'warnIfNone', 'failIfNone' (both taking a boolean (to use default message) or a string (which is the message)); and 'defaultIfNone' (a default value to return if there is no such property); defaults to no warning and null response

Specified by:

getFirst in interface StringConfigMap

Specified by:

getFirst in interface BrooklynProperties

See Also:

StringConfigMap.getFirst(java.util.Map, String...)

getFirst

public java.lang.String getFirst(java.util.Map flags,
                                 java.lang.String... keys)

Description copied from interface: StringConfigMap

returns the value of the first key which is defined

takes the following flags: 'warnIfNone' or 'failIfNone' (both taking a boolean (to use default message) or a string (which is the message)); and 'defaultIfNone' (a default value to return if there is no such property); defaults to no warning and null default value

Specified by:

getFirst in interface StringConfigMap

Specified by:

getFirst in interface BrooklynProperties

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

put

public java.lang.Object put(java.lang.Object rawKey,
                            java.lang.Object value)

like normal map.put, except config keys are dereferenced on the way in

Specified by:

put in interface BrooklynProperties

putAll

public void putAll(java.util.Map vals)

like normal map.putAll, except config keys are dereferenced on the way in

Specified by:

putAll in interface BrooklynProperties

put

public <T> java.lang.Object put(ConfigKey.HasConfigKey<T> key,
                                T value)

Specified by:

put in interface BrooklynProperties

put

public <T> java.lang.Object put(ConfigKey<T> key,
                                T value)

Specified by:

put in interface BrooklynProperties

putIfAbsent

public <T> boolean putIfAbsent(ConfigKey<T> key,
                               T value)

Specified by:

putIfAbsent in interface BrooklynProperties

getConfig

public java.lang.Object getConfig(java.lang.String key)

Specified by:

getConfig in interface BrooklynProperties

getConfig

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

Specified by:

getConfig in interface ConfigMap

Specified by:

getConfig in interface BrooklynProperties

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

Specified by:

getConfig in interface BrooklynProperties

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 BrooklynProperties

getConfig

public <T> T getConfig(ConfigKey<T> key,
                       T defaultValue)

Description copied from interface: BrooklynProperties

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 BrooklynProperties

getConfigRaw

public Maybe<java.lang.Object> getConfigRaw(ConfigKey<?> key)

Specified by:

getConfigRaw in interface BrooklynProperties

getConfigRaw

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

Description copied from interface: BrooklynProperties

Inheritance is ignored here. Preferable to use BrooklynProperties.getConfigRaw(ConfigKey).

Specified by:

getConfigRaw in interface ConfigMap

Specified by:

getConfigRaw in interface BrooklynProperties

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

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.

Description copied from interface: ConfigMap

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

Specified by:

getAllConfig in interface ConfigMap

Specified by:

getAllConfig in interface BrooklynProperties

findKeys

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

Deprecated.

Specified by:

findKeys in interface ConfigMap

findKeysDeclared

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

Description copied from interface: ConfigMap

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))

Specified by:

findKeysDeclared in interface ConfigMap

findKeysPresent

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

Description copied from interface: ConfigMap

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.

Specified by:

findKeysPresent in interface ConfigMap

submap

public BrooklynProperties submap(<any> filter)

Description copied from interface: StringConfigMap

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

Specified by:

submap in interface ConfigMap

Specified by:

submap in interface StringConfigMap

Specified by:

submap in interface BrooklynProperties

submapByName

public BrooklynProperties submapByName(<any> filter)

Specified by:

submapByName in interface BrooklynProperties

asMapWithStringKeys

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

Description copied from interface: 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

Specified by:

asMapWithStringKeys in interface ConfigMap

Specified by:

asMapWithStringKeys in interface StringConfigMap

Specified by:

asMapWithStringKeys in interface BrooklynProperties

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ConfigMap

size

public int size()

Specified by:

size in interface ConfigMap

containsKey

public boolean containsKey(java.lang.String key)

Specified by:

containsKey in interface BrooklynProperties

containsKey

public boolean containsKey(ConfigKey<?> key)

Specified by:

containsKey in interface BrooklynProperties

remove

public boolean remove(java.lang.String key)

Specified by:

remove in interface BrooklynProperties

remove

public boolean remove(ConfigKey<?> key)

Specified by:

remove in interface BrooklynProperties