com.foreach.common.spring.properties

Class TypedPropertyMap<T>

java.lang.Object

com.foreach.common.spring.properties.TypedPropertyMap<T>

Type Parameters:

T - The type of the property key (most often String).

All Implemented Interfaces:

Cloneable, Map<T,Object>

Direct Known Subclasses:

CachingTypedPropertyMap

public class TypedPropertyMap<T>
extends Object
implements Map<T,Object>, Cloneable

A TypedPropertyMap is proxy for a source list of key/value pairs, that allows getting and setting of properties in a strongly typed fashion. Usually the source is a simple map with both String key and value.

For this to be possible, the properties must be defined. Meaning that every property key must have an associated strong typed to map to.

Additionally a ConversionService must be present that can perform the type conversion for every property.

Note: the standard implementation does not cache the fetched values and will always read from the backing source directly. See also CachingTypedPropertyMap.

This class also implements the Map interface to facilitate use in JSP/JSTL. Note that the semantics for the general Map interface might be somewhat dodgy and slower than a regular map.

See Also:

CachingTypedPropertyMap, PropertyTypeRegistry, PropertiesSource, ConversionService

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected PropertyTypeRegistry<T>	propertyTypeRegistry
protected PropertiesSource	source
protected Class	sourceValueClass

Constructor Summary

Constructors

Constructor and Description
TypedPropertyMap(PropertyTypeRegistry<T> propertyTypeRegistry, Map<T,?> source, Class sourceValueClass) Construct a new TypedPropertyMap.
TypedPropertyMap(PropertyTypeRegistry<T> propertyTypeRegistry, PropertiesSource source, Class sourceValueClass) Construct a new TypedPropertyMap.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
TypedPropertyMap<T>	detach() Creates a duplicate of the TypedPropertyMap with its own property source, but the same registry and conversionService.
Set<Map.Entry<T,Object>>	entrySet()
Object	get(Object key)
PropertiesSource	getSource()
<O> O	getValue(T property) Allows a strong typed property to be fetched from the source map.
<O> O	getValue(T property, Class<O> expectedType) Fetches a property from the source map and converts it to the type expected.
<O> O	getValue(T property, org.springframework.core.convert.TypeDescriptor expectedType) Fetches a property from the source map and converts it to the type expected.
boolean	isEmpty()
Set<T>	keySet()
Object	put(T key, Object value)
void	putAll(Map<? extends T,?> m)
Object	remove(Object key)
Object	set(T property, Object value) Stores the property value in the source map by converting it to the sourceValueClass first.
int	size()
Collection<Object>	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

propertyTypeRegistry

protected final PropertyTypeRegistry<T> propertyTypeRegistry

sourceValueClass

protected final Class sourceValueClass

source

protected final PropertiesSource source

Constructor Detail

TypedPropertyMap

public TypedPropertyMap(PropertyTypeRegistry<T> propertyTypeRegistry,
                        Map<T,?> source,
                        Class sourceValueClass)

Construct a new TypedPropertyMap.

Parameters:

propertyTypeRegistry - Registry that contains the property keys with their corresponding type and conversion information.

source - Backing source map containing the stored values.

sourceValueClass - Class to use when setting values on the source map.

TypedPropertyMap

public TypedPropertyMap(PropertyTypeRegistry<T> propertyTypeRegistry,
                        PropertiesSource source,
                        Class sourceValueClass)

Construct a new TypedPropertyMap.

Parameters:

propertyTypeRegistry - Registry that contains the property keys with their corresponding type.

source - Backing source proxy containing the stored values.

sourceValueClass - Class to use when setting values on the source map.

See Also:

PropertiesSource

Method Detail

getSource

public PropertiesSource getSource()

Returns:

The source backing this typed property map.

getValue

public <O> O getValue(T property)

Allows a strong typed property to be fetched from the source map. This method will lookup the specific type of the property requested. Use the conversionService to convert the source value to the typed value, and then case the result to the type requested.

Type Parameters:

O - Strong type value to return, the must registered type for the property must be able to cast to this type!

Parameters:

property - Key of the property.

Returns:

Strong typed instance of the property.

getValue

public <O> O getValue(T property,
                      Class<O> expectedType)

Fetches a property from the source map and converts it to the type expected. This circumvents the registry but forces a conversion to the requested target type.

Type Parameters:

O - Strong type value to return.

Parameters:

property - Key of the property.

expectedType - Type the value should be converted to and will be returned.

Returns:

Strong typed instance of the property.

getValue

public <O> O getValue(T property,
                      org.springframework.core.convert.TypeDescriptor expectedType)

Fetches a property from the source map and converts it to the type expected. This circumvents the registry but forces a conversion to the requested target type.

Type Parameters:

O - Strong type value to return, converted value will be cast to the return type.

Parameters:

property - Key of the property.

expectedType - Type the value should be converted to and will be returned.

Returns:

Strong typed instance of the property.

set

public Object set(T property,
                  Object value)

Stores the property value in the source map by converting it to the sourceValueClass first.

Parameters:

property - Key of the property.

value - Strong type value to set the property to.

size

public int size()

Specified by:

size in interface Map<T,Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<T,Object>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<T,Object>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<T,Object>

get

public Object get(Object key)

Specified by:

get in interface Map<T,Object>

put

public Object put(T key,
                  Object value)

Specified by:

put in interface Map<T,Object>

remove

public Object remove(Object key)

Specified by:

remove in interface Map<T,Object>

putAll

public void putAll(Map<? extends T,?> m)

Specified by:

putAll in interface Map<T,Object>

clear

public void clear()

Specified by:

clear in interface Map<T,Object>

keySet

public Set<T> keySet()

Specified by:

keySet in interface Map<T,Object>

values

public Collection<Object> values()

Specified by:

values in interface Map<T,Object>

entrySet

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

Specified by:

entrySet in interface Map<T,Object>

detach

public TypedPropertyMap<T> detach()

Creates a duplicate of the TypedPropertyMap with its own property source, but the same registry and conversionService.

Returns:

Detached duplicate of the current map.