|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.commons.collections.map.AbstractMapDecorator | +--org.apache.commons.collections.map.TransformedMap
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.
Inner classes inherited from class java.util.Map |
Map.Entry |
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 | |
protected |
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)
|
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.AbstractMapDecorator |
clear, containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, keySet, remove, size, toString, values |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
protected final Transformer keyTransformer
protected final Transformer valueTransformer
Constructor Detail |
protected TransformedMap(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 conversionIllegalArgumentException
- if map is nullMethod Detail |
public static Map decorate(Map map, Transformer keyTransformer, Transformer valueTransformer)
If there are any elements already in the map 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 conversionIllegalArgumentException
- if map is nullprotected Object transformKey(Object object)
The transformer itself may throw an exception if necessary.
object
- the object to transformthe
- transformed objectprotected Object transformValue(Object object)
The transformer itself may throw an exception if necessary.
object
- the object to transformthe
- transformed objectprotected Map transformMap(Map map)
The transformer itself may throw an exception if necessary.
map
- the map to transformthe
- transformed objectpublic Object put(Object key, Object value)
put
in class AbstractMapDecorator
public void putAll(Map mapToCopy)
putAll
in class AbstractMapDecorator
public Set entrySet()
entrySet
in class AbstractMapDecorator
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |