org.apache.commons.collections.map

Class TransformedMap

Implemented Interfaces:
Map, Serializable
Known Direct Subclasses:
TransformedSortedMap

public class TransformedMap
extends org.apache.commons.collections.map.AbstractInputCheckedMapDecorator
implements Serializable

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.

This class is Serializable from Commons Collections 3.1.

Version:
$Revision: 1.11 $ $Date: 2004/06/07 22:14:42 $
Author:
Stephen Colebourne
Since:
Commons Collections 3.0

Field Summary

protected Transformer
keyTransformer
The transformer to use for the key
protected Transformer
valueTransformer
The transformer to use for the value

Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator

map

Constructor Summary

TransformedMap(Map map, Transformer keyTransformer, Transformer valueTransformer)
Constructor that wraps (not copies).

Method Summary

protected Object
checkSetValue(Object value)
Override to transform the value when using setValue.
static Map
decorate(Map map, Transformer keyTransformer, Transformer valueTransformer)
Factory method to create a transforming map.
protected boolean
isSetValueChecking()
Override to only return true when there is a value transformer.
Object
put(Object key, Object value)
void
putAll(Map mapToCopy)
protected Object
transformKey(Object object)
Transforms a key.
protected Map
transformMap(Map map)
Transforms a map.
protected Object
transformValue(Object object)
Transforms a value.

Methods inherited from class org.apache.commons.collections.map.AbstractInputCheckedMapDecorator

checkSetValue, entrySet, isSetValueChecking

Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator

clear, containsKey, containsValue, entrySet, equals, get, getMap, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values

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

Method Details

checkSetValue

protected Object checkSetValue(Object value)
Override to transform the value when using setValue.
Overrides:
checkSetValue in interface org.apache.commons.collections.map.AbstractInputCheckedMapDecorator
Parameters:
value - the value to transform
Returns:
the transformed value
Since:
Commons Collections 3.1

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

isSetValueChecking

protected boolean isSetValueChecking()
Override to only return true when there is a value transformer.
Overrides:
isSetValueChecking in interface org.apache.commons.collections.map.AbstractInputCheckedMapDecorator
Returns:
true if a value transformer is in use
Since:
Commons Collections 3.1

put

public Object put(Object key,
                  Object value)
Overrides:
put in interface AbstractMapDecorator

putAll

public void putAll(Map mapToCopy)
Overrides:
putAll in interface AbstractMapDecorator

transformKey

protected Object transformKey(Object object)
Transforms a key.

The transformer itself may throw an exception if necessary.

Parameters:
object - the object to transform

transformMap

protected Map transformMap(Map map)
Transforms a map.

The transformer itself may throw an exception if necessary.

Parameters:
map - the map to transform

transformValue

protected Object transformValue(Object object)
Transforms a value.

The transformer itself may throw an exception if necessary.

Parameters:
object - the object to transform

Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.