public class TransformedMap extends AbstractMapDecorator implements Serializable
Map to transform objects that are added.
The Map put methods and Map.Entry setValue method are affected by this class. Thus objects must be removed or searched for using their transformed form. For example, if the transformation converts Strings to Integers, you must use the Integer form to remove objects.
Note that TransformedMap is not synchronized and is not thread-safe.
If you wish to use this map from multiple threads concurrently, you must use
appropriate synchronization. The simplest approach is to wrap this map
using Collections.synchronizedMap(Map). This class may throw
exceptions when accessed by concurrent threads without synchronization.
This class is Serializable from Commons Collections 3.1.
| Modifier and Type | Field and Description |
|---|---|
protected Transformer |
keyTransformer
The transformer to use for the key
|
protected Transformer |
valueTransformer
The transformer to use for the value
|
map| Modifier | Constructor and Description |
|---|---|
protected |
TransformedMap(Map map,
Transformer keyTransformer,
Transformer valueTransformer)
Constructor that wraps (not copies).
|
| Modifier and Type | Method and Description |
|---|---|
protected Object |
checkSetValue(Object value)
Override to transform the value when using
setValue. |
static Map |
decorate(Map map,
Transformer keyTransformer,
Transformer valueTransformer)
Factory method to create a transforming map.
|
static Map |
decorateTransform(Map map,
Transformer keyTransformer,
Transformer valueTransformer)
Factory method to create a transforming map that will transform
existing contents of the specified map.
|
Set |
entrySet() |
protected boolean |
isSetValueChecking()
Override to only return true when there is a value transformer.
|
Object |
put(Object key,
Object value) |
void |
putAll(Map mapToCopy) |
protected Object |
transformKey(Object object)
Transforms a key.
|
protected Map |
transformMap(Map map)
Transforms a map.
|
protected Object |
transformValue(Object object)
Transforms a value.
|
clear, containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, keySet, remove, size, toString, valuesprotected final Transformer keyTransformer
protected final Transformer valueTransformer
protected TransformedMap(Map map, Transformer keyTransformer, Transformer valueTransformer)
If there are any elements already in the collection being decorated, they are NOT transformed.
map - the map to decorate, must not be nullkeyTransformer - the transformer to use for key conversion, null means no conversionvalueTransformer - the transformer to use for value conversion, null means no conversionIllegalArgumentException - if map is nullpublic static Map decorate(Map map, Transformer keyTransformer, Transformer valueTransformer)
If there are any elements already in the map being decorated, they
are NOT transformed.
Constrast this with decorateTransform(java.util.Map, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer).
map - the map to decorate, must not be nullkeyTransformer - the transformer to use for key conversion, null means no transformationvalueTransformer - the transformer to use for value conversion, null means no transformationIllegalArgumentException - if map is nullpublic static Map decorateTransform(Map map, Transformer keyTransformer, Transformer valueTransformer)
If there are any elements already in the map being decorated, they
will be transformed by this method.
Constrast this with decorate(java.util.Map, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer).
map - the map to decorate, must not be nullkeyTransformer - the transformer to use for key conversion, null means no transformationvalueTransformer - the transformer to use for value conversion, null means no transformationIllegalArgumentException - if map is nullprotected Object transformKey(Object object)
The transformer itself may throw an exception if necessary.
object - the object to transformthe - transformed objectprotected Object transformValue(Object object)
The transformer itself may throw an exception if necessary.
object - the object to transformthe - transformed objectprotected Map transformMap(Map map)
The transformer itself may throw an exception if necessary.
map - the map to transformthe - transformed objectprotected Object checkSetValue(Object value)
setValue.value - the value to transformprotected boolean isSetValueChecking()
public Object put(Object key, Object value)
put in interface Mapput in class AbstractMapDecoratorpublic void putAll(Map mapToCopy)
putAll in interface MapputAll in class AbstractMapDecoratorpublic Set entrySet()
entrySet in interface MapentrySet in class AbstractMapDecoratorCopyright © 2001–2015 The Apache Software Foundation. All rights reserved.