org.archive.spring

Class KeyedProperties

java.lang.Object

java.util.AbstractMap<K,V>

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

org.archive.spring.KeyedProperties

All Implemented Interfaces:

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

public class KeyedProperties
extends ConcurrentHashMap<String,Object>

Map for storing overridable properties. An object wanting to allow its properties to be overridden contextually will store those properties in this map. Its accessors (like getProp() and setProp()) will only pass-through to the 'prop' entry in this map.)

See Also:

Serialized Form

Nested Class Summary

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>

Field Summary

Fields

Modifier and Type	Field and Description
protected HashSet<String>	externalPaths the alternate global property-paths leading to this map TODO: consider if deterministic ordered list is important
protected static ThreadLocal<ArrayList<OverlayContext>>	threadOverrides ThreadLocal (contextual) collection of pushed override maps

Constructor Summary

Constructors

Constructor and Description
KeyedProperties()

Method Summary

Methods

Modifier and Type	Method and Description
void	addExternalPath(String path) Add a path by which the outside world can reach this map
static void	clearAllOverrideContexts()
static boolean	clearOverridesFrom(OverlayContext ocontext)
Object	get(String key) Get the given value, checking override maps if appropriate.
protected List<String>	getOverrideKeys(String key) Compose the complete keys (externalPath + local key name) to use for checking for contextual overrides.
static void	loadOverridesFrom(OverlayContext ocontext)
static boolean	overridesActiveFrom(OverlayContext ocontext)
static OverlayContext	popOverridesContext() Remove last-added override map from the stack
static void	pushOverrideContext(OverlayContext ocontext) Add an override map to the stack
static void	withOverridesDo(OverlayContext ocontext, Runnable todo)

Methods inherited from class java.util.concurrent.ConcurrentHashMap

clear, contains, containsKey, containsValue, elements, entrySet, get, isEmpty, keys, keySet, put, putAll, putIfAbsent, remove, remove, replace, replace, size, values

Methods inherited from class java.util.AbstractMap

clone, equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

externalPaths

protected HashSet<String> externalPaths

the alternate global property-paths leading to this map TODO: consider if deterministic ordered list is important

threadOverrides

protected static ThreadLocal<ArrayList<OverlayContext>> threadOverrides

ThreadLocal (contextual) collection of pushed override maps

Constructor Detail

KeyedProperties

public KeyedProperties()

Method Detail

addExternalPath

public void addExternalPath(String path)

Add a path by which the outside world can reach this map

Parameters:

path - String path

get

public Object get(String key)

Get the given value, checking override maps if appropriate.

Parameters:

key -

Returns:

discovered override, or local value

getOverrideKeys

protected List<String> getOverrideKeys(String key)

Compose the complete keys (externalPath + local key name) to use for checking for contextual overrides.

Parameters:

key - local key to compose

Returns:

List of full keys to check

pushOverrideContext

public static void pushOverrideContext(OverlayContext ocontext)

Add an override map to the stack

Parameters:

m - Map to add

popOverridesContext

public static OverlayContext popOverridesContext()

Remove last-added override map from the stack

Returns:

Map removed

clearAllOverrideContexts

public static void clearAllOverrideContexts()

loadOverridesFrom

public static void loadOverridesFrom(OverlayContext ocontext)

clearOverridesFrom

public static boolean clearOverridesFrom(OverlayContext ocontext)

withOverridesDo

public static void withOverridesDo(OverlayContext ocontext,
                   Runnable todo)

overridesActiveFrom

public static boolean overridesActiveFrom(OverlayContext ocontext)