public class TransformedMap<K,V> extends AbstractMapDecorator<K ,V> 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. This class may throw exceptions when accessed by concurrent threads without synchronization.
This class is Serializable from Commons Collections 3.1.
TransformedSplitMap,
Serialized Form
| 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
|
| Modifier | Constructor and Description |
|---|---|
protected |
TransformedMap(Map
Constructor that wraps (not copies).
|
| Modifier and Type | Method and Description |
|---|---|
protected V |
checkSetValue(V value)
Override to transform the value when using
setValue.
|
Set |
entrySet()
|
protected boolean |
isSetValueChecking()
Override to only return true when there is a value transformer.
|
V |
put(K key, V value)
Note that the return type is Object, rather than V as in the Map interface.
|
void |
putAll(Map
|
static <K |
transformedMap(Map
Factory method to create a transforming map that will transform existing contents of the specified map.
|
static <K |
transformingMap(Map
Factory method to create a transforming map.
|
protected K |
transformKey(K object)
Transforms a key.
|
protected Map |
transformMap(Map
Transforms a map.
|
protected V |
transformValue(V object)
Transforms a value.
|
clear, containsKey, containsValue, decorated, equals, get, hashCode, isEmpty, keySet, remove, size, toString, valuesmapIteratorclone, finalize, getClass, notify, notifyAll, wait, wait, waitcompute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAllprotected final Transformer<? super K ,? extends K> keyTransformer
protected final Transformer<? super V ,? extends V> valueTransformer
protected TransformedMap(Map<K ,V> map, Transformer <? super K ,? extends K> keyTransformer, Transformer <? super V ,? extends V> valueTransformer)
If there are any elements already in the collection being decorated, they are NOT transformed.
map - the map to decorate, must not be null
keyTransformer - the transformer to use for key conversion, null means no conversion
valueTransformer - the transformer to use for value conversion, null means no conversion
NullPointerException - if map is null
public static <K,V> TransformedMap <K ,V> transformingMap(Map <K ,V> map, Transformer <? super K ,? extends K> keyTransformer, Transformer <? super V ,? extends V> valueTransformer)
If there are any elements already in the map being decorated, they are NOT transformed. Contrast this with transformedMap(Map, Transformer, Transformer).
K - the key type
V - the value type
map - the map to decorate, must not be null
keyTransformer - the transformer to use for key conversion, null means no transformation
valueTransformer - the transformer to use for value conversion, null means no transformation
NullPointerException - if map is null
public static <K,V> TransformedMap <K ,V> transformedMap(Map <K ,V> map, Transformer <? super K ,? extends K> keyTransformer, Transformer <? super V ,? extends V> valueTransformer)
If there are any elements already in the map being decorated, they will be transformed by this method. Contrast this with transformingMap(Map, Transformer, Transformer).
K - the key type
V - the value type
map - the map to decorate, must not be null
keyTransformer - the transformer to use for key conversion, null means no transformation
valueTransformer - the transformer to use for value conversion, null means no transformation
NullPointerException - if map is null
protected K transformKey(K object)
The transformer itself may throw an exception if necessary.
object - the object to transform
protected V transformValue(V object)
The transformer itself may throw an exception if necessary.
object - the object to transform
protected Map<K ,V> transformMap(Map <? extends K ,? extends V> map)
The transformer itself may throw an exception if necessary.
map - the map to transform
protected V checkSetValue(V value)
setValue.
value - the value to transform
protected boolean isSetValueChecking()
public V put(K key, V value)
Put
public Set<Map .Entry <K ,V>> entrySet()
entrySet in interface
Map<K,V>
entrySet in interface
Get<K,V>
entrySet in class
AbstractMapDecorator<K,V>
Map.entrySet()