⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.apache.commons.collections.map

Class TransformedMap

java.lang.Object
|
+--org.apache.commons.collections.map.AbstractMapDecorator
   |
   +--org.apache.commons.collections.map.TransformedMap

Known Direct Subclasses:
TransformedSortedMap


public class TransformedMap
extends AbstractMapDecorator

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.

Since:
Commons Collections 3.0
Author:
Stephen Colebourne

Field Summary

Transformer

keyTransformer

The transformer to use for the key

Transformer

valueTransformer

The transformer to use for the value

Constructor Summary

TransformedMap(Map map, Transformer keyTransformer, Transformer valueTransformer)

Constructor that wraps (not copies).

Method Summary

static Map

decorate(Map map, Transformer keyTransformer, Transformer valueTransformer)

Factory method to create a transforming map.

Set

entrySet()

Object

put(Object key, Object value)

void

putAll(Map mapToCopy)

Object

transformKey(Object object)

Transforms a key.

Map

transformMap(Map map)

Transforms a map.

Object

transformValue(Object object)

Transforms a value.

Field Details

keyTransformer

protected final Transformer keyTransformer

The transformer to use for the key


valueTransformer

protected final Transformer valueTransformer

The transformer to use for the value

Constructor Details

TransformedMap

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:
- if map is null

Method Details

decorate

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.

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:
- if map is null

entrySet

public Set entrySet()


put

public Object put(Object key, Object value)

Parameters:
key
value

putAll

public void putAll(Map mapToCopy)

Parameters:
mapToCopy

transformKey

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

transformMap

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

transformValue

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