public class TransformedMap extends AbstractInputCheckedMapDecorator implements java.io.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.
AbstractInputCheckedMapDecorator.EntrySet, AbstractInputCheckedMapDecorator.EntrySetIterator, AbstractInputCheckedMapDecorator.MapEntry
Modifier and Type | Field and Description |
---|---|
protected Transformer |
keyTransformer
The transformer to use for the key
|
private static long |
serialVersionUID
Serialization version
|
protected Transformer |
valueTransformer
The transformer to use for the value
|
map
Modifier | Constructor and Description |
---|---|
protected |
TransformedMap(java.util.Map map,
Transformer keyTransformer,
Transformer valueTransformer)
Constructor that wraps (not copies).
|
Modifier and Type | Method and Description |
---|---|
protected java.lang.Object |
checkSetValue(java.lang.Object value)
Override to transform the value when using
setValue . |
static java.util.Map |
decorate(java.util.Map map,
Transformer keyTransformer,
Transformer valueTransformer)
Factory method to create a transforming map.
|
static java.util.Map |
decorateTransform(java.util.Map map,
Transformer keyTransformer,
Transformer valueTransformer)
Factory method to create a transforming map that will transform
existing contents of the specified map.
|
protected boolean |
isSetValueChecking()
Override to only return true when there is a value transformer.
|
java.lang.Object |
put(java.lang.Object key,
java.lang.Object value) |
void |
putAll(java.util.Map mapToCopy) |
private void |
readObject(java.io.ObjectInputStream in)
Read the map in using a custom routine.
|
protected java.lang.Object |
transformKey(java.lang.Object object)
Transforms a key.
|
protected java.util.Map |
transformMap(java.util.Map map)
Transforms a map.
|
protected java.lang.Object |
transformValue(java.lang.Object object)
Transforms a value.
|
private void |
writeObject(java.io.ObjectOutputStream out)
Write the map out using a custom routine.
|
entrySet
clear, containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, keySet, remove, size, toString, values
private static final long serialVersionUID
protected final Transformer keyTransformer
protected final Transformer valueTransformer
protected TransformedMap(java.util.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 conversionjava.lang.IllegalArgumentException
- if map is nullpublic static java.util.Map decorate(java.util.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 transformationjava.lang.IllegalArgumentException
- if map is nullpublic static java.util.Map decorateTransform(java.util.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 transformationjava.lang.IllegalArgumentException
- if map is nullprivate void writeObject(java.io.ObjectOutputStream out) throws java.io.IOException
out
- the output streamjava.io.IOException
private void readObject(java.io.ObjectInputStream in) throws java.io.IOException, java.lang.ClassNotFoundException
in
- the input streamjava.io.IOException
java.lang.ClassNotFoundException
protected java.lang.Object transformKey(java.lang.Object object)
The transformer itself may throw an exception if necessary.
object
- the object to transformthe
- transformed objectprotected java.lang.Object transformValue(java.lang.Object object)
The transformer itself may throw an exception if necessary.
object
- the object to transformthe
- transformed objectprotected java.util.Map transformMap(java.util.Map map)
The transformer itself may throw an exception if necessary.
map
- the map to transformthe
- transformed objectprotected java.lang.Object checkSetValue(java.lang.Object value)
setValue
.checkSetValue
in class AbstractInputCheckedMapDecorator
value
- the value to transformprotected boolean isSetValueChecking()
isSetValueChecking
in class AbstractInputCheckedMapDecorator
public java.lang.Object put(java.lang.Object key, java.lang.Object value)
put
in interface java.util.Map
put
in class AbstractMapDecorator
public void putAll(java.util.Map mapToCopy)
putAll
in interface java.util.Map
putAll
in class AbstractMapDecorator