io.engineblock.activityimpl

Class ParameterMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.concurrent.ConcurrentHashMap<String,Object>

io.engineblock.activityimpl.ParameterMap

All Implemented Interfaces:

Serializable, ConcurrentMap<String,Object>, Map<String,Object>, Bindings

public class ParameterMap
extends ConcurrentHashMap<String,Object>
implements Bindings

A concurrently accessible parameter map which holds both keys and values as strings. An atomic change counter tracks updates, to allow interested consumers to determine when to re-read values across threads. The basic format is <paramname>=<paramvalue>;...

To create a parameter map, use one of the static parse... methods.

No non-String types are used internally. Everything is encoded as a String, even though the generic type is parameterized for Bindings support.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ParameterMap.Listener

Nested classes/interfaces inherited from class java.util.concurrent.ConcurrentHashMap

ConcurrentHashMap.KeySetView<K,V>

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

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

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ParameterMap(Map<String,String> valueMap)

Method Summary

Modifier and Type	Method and Description
void	addListener(ParameterMap.Listener listener)
void	clear()
Set<Map.Entry<String,Object>>	entrySet()
Object	get(Object key)
boolean	getBoolOrDefault(String paramName, boolean defaultBoolValue)
AtomicLong	getChangeCounter() Get the atomic change counter for this parameter map.
double	getDoubleOrDefault(String paramName, double defaultDoubleValue)
int	getIntOrDefault(String paramName, int defaultIntValue)
long	getLongOrDefault(String paramName, long defaultLongValue)
Optional<Boolean>	getOptionalBoolean(String paramName)
Optional<Double>	getOptionalDouble(String paramName)
Optional<Long>	getOptionalLong(String paramName)
Optional<String>	getOptionalString(String paramName)
int	getSize()
String	getStringOrDefault(String paramName, String defaultStringValue)
Map<String,String>	getStringStringMap()
static ParameterMap	parseOrException(String encodedParams)
static Optional<ParameterMap>	parseParams(String encodedParams)
static ParameterMap	parsePositional(String encodedParams, String[] defaultFieldNames) Parse positional parameters, each suffixed with the ';' terminator.
Object	put(String name, Object value)
void	putAll(Map<? extends String,? extends Object> toMerge)
Object	remove(Object key)
void	removeListener(ParameterMap.Listener listener)
void	set(String paramName, Object newValue)
boolean	takeBoolOrDefault(String paramName, boolean defaultBoolValue)
Double	takeDoubleOrDefault(String paramName, double defaultDoubleValue)
int	takeIntOrDefault(String paramName, int paramDefault)
Long	takeLongOrDefault(String paramName, Long defaultLongValue)
String	takeStringOrDefault(String paramName, String defaultStringValue)
String	toString()

Methods inherited from class java.util.concurrent.ConcurrentHashMap

compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, equals, forEach, forEach, forEach, forEachEntry, forEachEntry, forEachKey, forEachKey, forEachValue, forEachValue, getOrDefault, hashCode, isEmpty, keys, keySet, keySet, mappingCount, merge, newKeySet, newKeySet, putIfAbsent, reduce, reduceEntries, reduceEntries, reduceEntriesToDouble, reduceEntriesToInt, reduceEntriesToLong, reduceKeys, reduceKeys, reduceKeysToDouble, reduceKeysToInt, reduceKeysToLong, reduceToDouble, reduceToInt, reduceToLong, reduceValues, reduceValues, reduceValuesToDouble, reduceValuesToInt, reduceValuesToLong, remove, replace, replace, replaceAll, search, searchEntries, searchKeys, searchValues, size, values

Methods inherited from class java.util.AbstractMap

clone

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.script.Bindings

containsKey

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsValue, equals, forEach, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, replace, replace, replaceAll, size, values

Constructor Detail

ParameterMap

public ParameterMap(Map<String,String> valueMap)

Method Detail

getLongOrDefault

public long getLongOrDefault(String paramName,
                             long defaultLongValue)

getDoubleOrDefault

public double getDoubleOrDefault(String paramName,
                                 double defaultDoubleValue)

getStringOrDefault

public String getStringOrDefault(String paramName,
                                 String defaultStringValue)

getOptionalString

public Optional<String> getOptionalString(String paramName)

getOptionalLong

public Optional<Long> getOptionalLong(String paramName)

getOptionalDouble

public Optional<Double> getOptionalDouble(String paramName)

getOptionalBoolean

public Optional<Boolean> getOptionalBoolean(String paramName)

getIntOrDefault

public int getIntOrDefault(String paramName,
                           int defaultIntValue)

getBoolOrDefault

public boolean getBoolOrDefault(String paramName,
                                boolean defaultBoolValue)

takeLongOrDefault

public Long takeLongOrDefault(String paramName,
                              Long defaultLongValue)

takeDoubleOrDefault

public Double takeDoubleOrDefault(String paramName,
                                  double defaultDoubleValue)

takeStringOrDefault

public String takeStringOrDefault(String paramName,
                                  String defaultStringValue)

takeIntOrDefault

public int takeIntOrDefault(String paramName,
                            int paramDefault)

takeBoolOrDefault

public boolean takeBoolOrDefault(String paramName,
                                 boolean defaultBoolValue)

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

Specified by:

get in interface Bindings

Overrides:

get in class ConcurrentHashMap<String,Object>

set

public void set(String paramName,
                Object newValue)

put

public Object put(String name,
                  Object value)

Specified by:

put in interface Map<String,Object>

Specified by:

put in interface Bindings

Overrides:

put in class ConcurrentHashMap<String,Object>

putAll

public void putAll(Map<? extends String,? extends Object> toMerge)

Specified by:

putAll in interface Map<String,Object>

Specified by:

putAll in interface Bindings

Overrides:

putAll in class ConcurrentHashMap<String,Object>

remove

public Object remove(Object key)

Specified by:

remove in interface Map<String,Object>

Specified by:

remove in interface Bindings

Overrides:

remove in class ConcurrentHashMap<String,Object>

clear

public void clear()

Specified by:

clear in interface Map<String,Object>

Overrides:

clear in class ConcurrentHashMap<String,Object>

entrySet

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

Specified by:

entrySet in interface Map<String,Object>

Overrides:

entrySet in class ConcurrentHashMap<String,Object>

getChangeCounter

public AtomicLong getChangeCounter()

Get the atomic change counter for this parameter map. It getes incremented whenever any changes are made to the map.

Returns:

the atomic long change counter

toString

public String toString()

Overrides:

toString in class ConcurrentHashMap<String,Object>

addListener

public void addListener(ParameterMap.Listener listener)

removeListener

public void removeListener(ParameterMap.Listener listener)

getSize

public int getSize()

parseOrException

public static ParameterMap parseOrException(String encodedParams)

parseParams

public static Optional<ParameterMap> parseParams(String encodedParams)

parsePositional

public static ParameterMap parsePositional(String encodedParams,
                                           String[] defaultFieldNames)

Parse positional parameters, each suffixed with the ';' terminator. This form simply allows for the initial parameter names to be elided, so long as they are sure to match up with a well-known order. This method cleans up the input, injecting the field names as necessary, and then calls the normal parsing logic.

Parameters:

encodedParams - parameter string

defaultFieldNames - the well-known field ordering

Returns:

a new ParameterMap, if parsing was successful

getStringStringMap

public Map<String,String> getStringStringMap()