| java.lang.Object
 org.apache.commons.collections.map.AbstractMapDecorator
org.apache.commons.collections.map.AbstractInputCheckedMapDecorator
org.apache.commons.collections.map.TransformedMap
All known Subclasses: org.apache.commons.collections.map.TransformedSortedMap,
| TransformedMap | | public class TransformedMap extends AbstractInputCheckedMapDecorator implements Serializable(Code) | | Decorates another 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
java.util.Collections.synchronizedMap(Map) . This class may throw
exceptions when accessed by concurrent threads without synchronization.
This class is Serializable from Commons Collections 3.1.
since:
Commons Collections 3.0
version:
$Revision: 348013 $ $Date: 2005-11-21 23:24:45 +0000 (Mon, 21 Nov 2005) $
author:
Stephen Colebourne |
| keyTransformer | | final protected Transformer keyTransformer(Code) | | The transformer to use for the key
|
| valueTransformer | | final protected Transformer valueTransformer(Code) | | The transformer to use for the value
|
| TransformedMap | | protected TransformedMap(Map map, Transformer keyTransformer, Transformer valueTransformer)(Code) | | Constructor that wraps (not copies).
If there are any elements already in the collection being decorated, they
are NOT transformed.
Parameters:
map - the map to decorate, must not be null
Parameters:
keyTransformer - the transformer to use for key conversion, null means no conversion
Parameters:
valueTransformer - the transformer to use for value conversion, null means no conversion
throws:
IllegalArgumentException - if map is null |
| checkSetValue | | protected Object checkSetValue(Object value)(Code) | | Override to transform the value when using setValue.
Parameters:
value - the value to transform the transformed value
since:
Commons Collections 3.1 |
| decorate | | public static Map decorate(Map map, Transformer keyTransformer, Transformer valueTransformer)(Code) | | Factory method to create a transforming map.
If there are any elements already in the map being decorated, they
are NOT transformed.
Constrast this with
TransformedMap.decorateTransform .
Parameters:
map - the map to decorate, must not be null
Parameters:
keyTransformer - the transformer to use for key conversion, null means no transformation
Parameters:
valueTransformer - the transformer to use for value conversion, null means no transformation
throws:
IllegalArgumentException - if map is null |
| decorateTransform | | public static Map decorateTransform(Map map, Transformer keyTransformer, Transformer valueTransformer)(Code) | | Factory method to create a transforming map that will transform
existing contents of the specified map.
If there are any elements already in the map being decorated, they
will be transformed by this method.
Constrast this with
TransformedMap.decorate .
Parameters:
map - the map to decorate, must not be null
Parameters:
keyTransformer - the transformer to use for key conversion, null means no transformation
Parameters:
valueTransformer - the transformer to use for value conversion, null means no transformation
throws:
IllegalArgumentException - if map is null
since:
Commons Collections 3.2 |
| isSetValueChecking | | protected boolean isSetValueChecking()(Code) | | Override to only return true when there is a value transformer.
true if a value transformer is in use
since:
Commons Collections 3.1 |
| putAll | | public void putAll(Map mapToCopy)(Code) | | |
| transformKey | | protected Object transformKey(Object object)(Code) | | Transforms a key.
The transformer itself may throw an exception if necessary.
Parameters:
object - the object to transform
throws:
the - transformed object |
| transformMap | | protected Map transformMap(Map map)(Code) | | Transforms a map.
The transformer itself may throw an exception if necessary.
Parameters:
map - the map to transform
throws:
the - transformed object |
| transformValue | | protected Object transformValue(Object object)(Code) | | Transforms a value.
The transformer itself may throw an exception if necessary.
Parameters:
object - the object to transform
throws:
the - transformed object |
| Fields inherited from org.apache.commons.collections.map.AbstractMapDecorator | protected transient Map map(Code)(Java Doc)
|
|
|