public class

TransformedMap

extends AbstractMapDecorator
implements Serializable
java.lang.Object
   ↳ org.apache.commons.collections.map.AbstractMapDecorator
     ↳ org.apache.commons.collections.map.TransformedMap
Known Direct Subclasses

Class Overview

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 synchronizedMap(Map). This class may throw exceptions when accessed by concurrent threads without synchronization.

This class is Serializable from Commons Collections 3.1.

Summary

Fields
protected final Transformer keyTransformer The transformer to use for the key
protected final Transformer valueTransformer The transformer to use for the value
[Expand]
Inherited Fields
From class org.apache.commons.collections.map.AbstractMapDecorator
Protected Constructors
TransformedMap(Map map, Transformer keyTransformer, Transformer valueTransformer)
Constructor that wraps (not copies).
Public Methods
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()
Object put(Object key, Object value)
void putAll(Map mapToCopy)
Protected Methods
Object checkSetValue(Object value)
Override to transform the value when using setValue.
boolean isSetValueChecking()
Override to only return true when there is a value transformer.
Object transformKey(Object object)
Transforms a key.
Map transformMap(Map map)
Transforms a map.
Object transformValue(Object object)
Transforms a value.
[Expand]
Inherited Methods
From class org.apache.commons.collections.map.AbstractMapDecorator
From class java.lang.Object
From interface java.util.Map

Fields

protected final Transformer keyTransformer

The transformer to use for the key

protected final Transformer valueTransformer

The transformer to use for the value

Protected Constructors

protected TransformedMap (Map map, Transformer keyTransformer, Transformer valueTransformer)

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
keyTransformer the transformer to use for key conversion, null means no conversion
valueTransformer the transformer to use for value conversion, null means no conversion
Throws
IllegalArgumentException if map is null

Public Methods

public static Map decorate (Map map, Transformer keyTransformer, Transformer valueTransformer)

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 decorateTransform(Map, Transformer, Transformer).

Parameters
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
Throws
IllegalArgumentException if map is null

public 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.

If there are any elements already in the map being decorated, they will be transformed by this method. Constrast this with decorate(Map, Transformer, Transformer).

Parameters
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
Throws
IllegalArgumentException if map is null

public Set entrySet ()

public Object put (Object key, Object value)

public void putAll (Map mapToCopy)

Protected Methods

protected Object checkSetValue (Object value)

Override to transform the value when using setValue.

Parameters
value the value to transform
Returns
  • the transformed value

protected boolean isSetValueChecking ()

Override to only return true when there is a value transformer.

Returns
  • true if a value transformer is in use

protected Object transformKey (Object object)

Transforms a key.

The transformer itself may throw an exception if necessary.

Parameters
object the object to transform
Throws
transformed object

protected Map transformMap (Map map)

Transforms a map.

The transformer itself may throw an exception if necessary.

Parameters
map the map to transform
Throws
transformed object

protected Object transformValue (Object object)

Transforms a value.

The transformer itself may throw an exception if necessary.

Parameters
object the object to transform
Throws
transformed object