org.apache.brooklyn.core.internal

Interface BrooklynProperties

All Superinterfaces:

ConfigMap, StringConfigMap

All Known Implementing Classes:

BrooklynPropertiesImpl, DeferredBrooklynProperties

public interface BrooklynProperties
extends StringConfigMap

Utils for accessing command-line and system-env properties; doesn't resolve anything (unless an execution context is supplied) and treats ConfigKeys as of type object when in doubt, or string when that is likely wanted (e.g. getFirst(Map, String...)

Intention for normal use is that they are set during startup and not modified thereafter.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BrooklynProperties.Factory

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

ConfigMap.ConfigMapWithInheritance<TContainer>

Method Summary

Modifier and Type	Method and Description
BrooklynProperties	addEnvironmentVars()
BrooklynProperties	addFrom(ConfigBag cfg)
BrooklynProperties	addFrom(java.io.File f)
BrooklynProperties	addFrom(java.io.InputStream i)
BrooklynProperties	addFrom(java.util.Map map)
BrooklynProperties	addFrom(java.net.URL u)
BrooklynProperties	addFromMap(java.util.Map properties) adds the indicated properties
BrooklynProperties	addFromUrl(java.lang.String url)
BrooklynProperties	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
BrooklynProperties	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.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.
<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>	getConfigRaw(ConfigKey<?> key)
Maybe<java.lang.Object>	getConfigRaw(ConfigKey<?> key, boolean includeInherited) Deprecated. since 0.10.0 the second parameter is ignored for BrooklynProperties; use ConfigMap.getConfigLocalRaw(ConfigKey).
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
<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 key, 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(Map), 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)
BrooklynProperties	submap(<any> filter) returns submap matching the given filter predicate; see ConfigPredicates for common predicates
BrooklynProperties	submapByName(<any> filter)

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

findKeys, findKeysDeclared, findKeysPresent, getAllConfigLocalRaw, getConfigLocalRaw, isEmpty, size

Method Detail

addEnvironmentVars

BrooklynProperties addEnvironmentVars()

addSystemProperties

BrooklynProperties addSystemProperties()

addFrom

BrooklynProperties addFrom(ConfigBag cfg)

addFrom

BrooklynProperties addFrom(java.util.Map map)

addFrom

BrooklynProperties addFrom(java.io.InputStream i)

addFrom

BrooklynProperties addFrom(java.io.File f)

addFrom

BrooklynProperties addFrom(java.net.URL u)

addFromUrl

BrooklynProperties addFromUrl(java.lang.String url)

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

BrooklynProperties 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

addFromMap

BrooklynProperties addFromMap(java.util.Map properties)

adds the indicated properties

putIfAbsent

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

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

get

@Deprecated
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).

getFirst

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

See Also:

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

getFirst

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

put

java.lang.Object put(java.lang.Object key,
                     java.lang.Object value)

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

putAll

void putAll(java.util.Map vals)

like normal Map.putAll(Map), except config keys are dereferenced on the way in

put

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

put

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

putIfAbsent

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

containsKey

boolean containsKey(java.lang.String key)

containsKey

boolean containsKey(ConfigKey<?> key)

remove

boolean remove(java.lang.String key)

remove

boolean remove(ConfigKey<?> key)

getConfig

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

getConfig

<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

<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

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

getConfig

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

getConfigRaw

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

getConfigRaw

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

Deprecated. since 0.10.0 the second parameter is ignored for BrooklynProperties; use ConfigMap.getConfigLocalRaw(ConfigKey).

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

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

@Deprecated
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

submap

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

submapByName

BrooklynProperties submapByName(<any> filter)

asMapWithStringKeys

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