org.apache.brooklyn.config

Interface StringConfigMap

All Superinterfaces:

ConfigMap

All Known Subinterfaces:

BrooklynProperties

All Known Implementing Classes:

BrooklynPropertiesImpl, DeferredBrooklynProperties

public interface StringConfigMap
extends ConfigMap

convenience extension where map is principally strings or converted to strings (supporting BrooklynProperties)

Nested Class Summary

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

ConfigMap.ConfigMapWithInheritance<TContainer>

Method Summary

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.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)
StringConfigMap	submap(<any> filter) returns submap matching the given filter predicate; see ConfigPredicates for common predicates

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

findKeys, findKeysDeclared, findKeysPresent, getAllConfig, getAllConfigLocalRaw, getConfig, getConfig, getConfigLocalRaw, getConfigRaw, isEmpty, size

Method Detail

getFirst

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

See Also:

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

getFirst

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

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

submap

StringConfigMap submap(<any> filter)

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

Specified by:

submap in interface ConfigMap

asMapWithStringKeys

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

Specified by:

asMapWithStringKeys in interface ConfigMap