Package org.actioncontroller.config

Class ConfigMap

java.lang.Object

java.util.AbstractMap<String,String>

org.actioncontroller.config.ConfigMap

All Implemented Interfaces:

Map<String,String>

public class ConfigMap
extends AbstractMap<String,String>

Extracts config values from an inner map or environment variables in a hierarchical fashion. For example new ConfigMap(map).subMap("foo").get("bar") will either return map.get("foo.bar"), System.getenv("FOO_BAR"), or throw ConfigException.

The most important operations:

• get(Object) returns the prefixed variable specified or environment variable with a comparable name or else throws exception
• getOrDefault(Object, String) returns the prefixed variable specified or environment variable with a comparable name or default value
• subMap(String) returns a ConfigMap which resolves all variables relative to the prefix
• entrySet() gets all entries with a key with the current prefix does not include environment variables

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
ConfigMap(FileListener observer)
ConfigMap(FileListener observer, String prefix, Map<String,String> innerMap)
ConfigMap(FileListener observer, String prefix, Map<String,String> innerMap, Map<String,String> environment)
ConfigMap(FileListener observer, Map<String,String> innerMap)
ConfigMap(FileListener observer, Properties properties)

Method Summary

Modifier and Type	Method	Description
Set<Map.Entry<String,String>>	entrySet()
String	get(Object key)	Returns the value of prefix.key or throws ConfigException if missing Use getOrDefault with defaultValue null to support optional values
boolean	getBoolean(String key)
Duration	getDuration(String key, Duration defaultValue)
Path	getFile(String key)
Optional<Path>	getFile(String key, String defaultValue)
InetSocketAddress	getInetSocketAddress(String key, int defaultPort)
String	getOrDefault(Object key, String defaultValue)	Returns the value of prefix.key or throws ConfigException if missing
Period	getPeriod(String key, Period defaultValue)
protected String	getPrefixedKey(Object key)
Path	getRegularFile(String key)
ConfigMap	getRoot()
Iterable<String>	getUntouchedProperties()
Collection<String>	listDirectProperties()
void	listenToFileChange(String key, Path path)
List<Path>	listFiles(String key)
List<Path>	listFiles(String key, String defaultPath)
List<Path>	listFiles(String key, Path directory, PathMatcher pathMatcher)
<T> Optional<T>	mapOptionalFile(String key, ConfigValueTransformer<Path,T> transformer)
Optional<String>	optional(Object key)
<T> Optional<T>	optional(String key, ConfigValueTransformer<String,T> transformer)
Optional<Path>	optionalFile(String key)
static ConfigMap	read(FileListener observer, File file)
Optional<ConfigMap>	subMap(String prefix)
String	toString()

Methods inherited from class java.util.AbstractMap

clear, clone, containsKey, containsValue, equals, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ConfigMap

public ConfigMap(FileListener observer,
                 String prefix,
                 Map<String,String> innerMap)

ConfigMap

public ConfigMap(FileListener observer,
                 String prefix,
                 Map<String,String> innerMap,
                 Map<String,String> environment)

ConfigMap

public ConfigMap(FileListener observer,
                 Map<String,String> innerMap)

ConfigMap

public ConfigMap(FileListener observer)

ConfigMap

public ConfigMap(FileListener observer,
                 Properties properties)

Method Detail

read

public static ConfigMap read(FileListener observer,
                             File file)
                      throws IOException

Throws:

IOException

optional

public Optional<String> optional(Object key)

optional

public <T> Optional<T> optional(String key,
                                ConfigValueTransformer<String,T> transformer)

get

public String get(Object key)

Returns the value of prefix.key or throws ConfigException if missing Use getOrDefault with defaultValue null to support optional values

Specified by:

get in interface Map<String,String>

Overrides:

get in class AbstractMap<String,String>

getOrDefault

public String getOrDefault(Object key,
                           String defaultValue)

Returns the value of prefix.key or throws ConfigException if missing

getBoolean

public boolean getBoolean(String key)

entrySet

public Set<Map.Entry<String,String>> entrySet()

Specified by:

entrySet in interface Map<String,String>

Specified by:

entrySet in class AbstractMap<String,String>

listDirectProperties

public Collection<String> listDirectProperties()

getRoot

public ConfigMap getRoot()

subMap

public Optional<ConfigMap> subMap(String prefix)

getPrefixedKey

protected String getPrefixedKey(Object key)

toString

public String toString()

Overrides:

toString in class AbstractMap<String,String>

getUntouchedProperties

public Iterable<String> getUntouchedProperties()

getInetSocketAddress

public InetSocketAddress getInetSocketAddress(String key,
                                              int defaultPort)

getDuration

public Duration getDuration(String key,
                            Duration defaultValue)

getPeriod

public Period getPeriod(String key,
                        Period defaultValue)

mapOptionalFile

public <T> Optional<T> mapOptionalFile(String key,
                                       ConfigValueTransformer<Path,T> transformer)
                                throws Exception

Throws:

Exception

getRegularFile

public Path getRegularFile(String key)

getFile

public Path getFile(String key)

optionalFile

public Optional<Path> optionalFile(String key)

getFile

public Optional<Path> getFile(String key,
                              String defaultValue)

listenToFileChange

public void listenToFileChange(String key,
                               Path path)

listFiles

public List<Path> listFiles(String key)

listFiles

public List<Path> listFiles(String key,
                            String defaultPath)

listFiles

public List<Path> listFiles(String key,
                            Path directory,
                            PathMatcher pathMatcher)