Overview  Package   Class  Deprecated  Index  Help 
Brooklyn
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

brooklyn.config
[Java] Class BrooklynProperties

java.lang.Object
  java.util.AbstractMap
      java.util.HashMap
          java.util.LinkedHashMap
              brooklyn.config.BrooklynProperties
All Implemented Interfaces:
StringConfigMap
@SuppressWarnings("rawtypes")
public class BrooklynProperties
extends java.util.LinkedHashMap

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

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

Nested Class Summary
static class BrooklynProperties.Factory

 
Method Summary
protected java.lang.Object BrooklynProperties()

BrooklynProperties addEnvironmentVars()

BrooklynProperties addFrom(java.io.InputStream i)

BrooklynProperties addFrom(java.io.File f)

BrooklynProperties addFrom(java.net.URL u)

BrooklynProperties addFromMap(java.util.Map properties)

adds the indicated properties
BrooklynProperties addFromUrl(java.lang.String url)

@see ResourceUtils#getResourceFromUrl(String)
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 asMapWithStringKeys()

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

java.lang.Object getConfig(ConfigKey key)

java.lang.Object getConfig(HasConfigKey key)

java.lang.Object getConfig(HasConfigKey key, java.lang.Object defaultValue)

java.lang.Object getConfig(ConfigKey key, java.lang.Object defaultValue)

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

returns the value of the first key which is defined
java.lang.String getFirst(java.util.Map flags, java.lang.String... keys)

java.lang.Object getRawConfig(ConfigKey key)

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
java.lang.Object put(HasConfigKey key, java.lang.Object value)

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

void putAll(java.util.Map vals)

like normal map.putAll, except config keys are dereferenced on the way in
boolean putIfAbsent(java.lang.String key, java.lang.Object value)

inserts the value under the given key, if it was not present
BrooklynProperties submap(Predicate filter)

java.lang.String toString()

 
Methods inherited from class java.util.LinkedHashMap
java.util.LinkedHashMap#get(java.lang.Object), java.util.LinkedHashMap#clear(), java.util.LinkedHashMap#containsValue(java.lang.Object), java.util.LinkedHashMap#put(java.lang.Object, java.lang.Object), java.util.LinkedHashMap#values(), java.util.LinkedHashMap#clone(), java.util.LinkedHashMap#isEmpty(), java.util.LinkedHashMap#size(), java.util.LinkedHashMap#entrySet(), java.util.LinkedHashMap#putAll(java.util.Map), java.util.LinkedHashMap#remove(java.lang.Object), java.util.LinkedHashMap#keySet(), java.util.LinkedHashMap#containsKey(java.lang.Object), java.util.LinkedHashMap#equals(java.lang.Object), java.util.LinkedHashMap#toString(), java.util.LinkedHashMap#hashCode(), java.util.LinkedHashMap#wait(), java.util.LinkedHashMap#wait(long), java.util.LinkedHashMap#wait(long, int), java.util.LinkedHashMap#getClass(), java.util.LinkedHashMap#notify(), java.util.LinkedHashMap#notifyAll()
 
Methods inherited from class java.util.HashMap
java.util.HashMap#get(java.lang.Object), java.util.HashMap#put(java.lang.Object, java.lang.Object), java.util.HashMap#values(), java.util.HashMap#clone(), java.util.HashMap#clear(), java.util.HashMap#isEmpty(), java.util.HashMap#size(), java.util.HashMap#entrySet(), java.util.HashMap#putAll(java.util.Map), java.util.HashMap#remove(java.lang.Object), java.util.HashMap#keySet(), java.util.HashMap#containsValue(java.lang.Object), java.util.HashMap#containsKey(java.lang.Object), java.util.HashMap#equals(java.lang.Object), java.util.HashMap#toString(), java.util.HashMap#hashCode(), java.util.HashMap#wait(), java.util.HashMap#wait(long), java.util.HashMap#wait(long, int), java.util.HashMap#getClass(), java.util.HashMap#notify(), java.util.HashMap#notifyAll()
 

Method Detail

BrooklynProperties

protected java.lang.Object BrooklynProperties()

addEnvironmentVars

putAll(System.getenv());
public BrooklynProperties addEnvironmentVars()

addFrom

public BrooklynProperties addFrom(java.io.InputStream i)

addFrom

public BrooklynProperties addFrom(java.io.File f)

addFrom

public BrooklynProperties addFrom(java.net.URL u)

addFromMap

}
public BrooklynProperties addFromMap(java.util.Map properties)
adds the indicated properties

addFromUrl

public BrooklynProperties addFromUrl(java.lang.String url)
See Also:
ResourceUtils#getResourceFromUrl(String)#getResourceFromUrl(String)

addFromUrlProperty

public 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

addSystemProperties

putAll(System.getProperties());
public BrooklynProperties addSystemProperties()

asMapWithStringKeys

}
}
public java.util.Map asMapWithStringKeys()

get

new Throwable("Arguments: "+flags+" "+key));
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).

getAllConfig

return result;
public java.util.Map getAllConfig()

getConfig

public java.lang.Object getConfig(ConfigKey key)

getConfig

public java.lang.Object getConfig(HasConfigKey key)

getConfig

public java.lang.Object getConfig(HasConfigKey key, java.lang.Object defaultValue)

getConfig

return key.getDefaultValue();
public java.lang.Object getConfig(ConfigKey key, java.lang.Object defaultValue)

getFirst

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

getFirst

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

getRawConfig

@Override
public java.lang.Object getRawConfig(ConfigKey key)

put

return super.put(key, value);
public 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

put

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

put

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

putAll

}
public void putAll(java.util.Map vals)
like normal map.putAll, except config keys are dereferenced on the way in

putIfAbsent

public boolean putIfAbsent(java.lang.String key, java.lang.Object value)
inserts the value under the given key, if it was not present

submap

if (filter.apply(k))
public BrooklynProperties submap(Predicate filter)

toString

public java.lang.String toString()

 

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.