Class TransformedMap
- java.lang.Object
-
- org.apache.commons.collections.map.AbstractMapDecorator
-
- org.apache.commons.collections.map.TransformedMap
-
- All Implemented Interfaces:
Serializable
,Map
- Direct Known Subclasses:
TransformedSortedMap
@Deprecated(since="2021-04-30") public class TransformedMap extends AbstractMapDecorator implements Serializable
Deprecated.Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.Decorates anotherMap
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
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
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static Map
decorate(Map map, Transformer keyTransformer, Transformer valueTransformer)
Deprecated.Factory method to create a transforming map.static Map
decorateTransform(Map map, Transformer keyTransformer, Transformer valueTransformer)
Deprecated.Factory method to create a transforming map that will transform existing contents of the specified map.Set
entrySet()
Deprecated.Object
put(Object key, Object value)
Deprecated.void
putAll(Map mapToCopy)
Deprecated.-
Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator
clear, containsKey, containsValue, equals, get, hashCode, isEmpty, keySet, remove, size, toString, values
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
-
-
Method Detail
-
decorate
public static Map decorate(Map map, Transformer keyTransformer, Transformer valueTransformer)
Deprecated.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(java.util.Map, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)
.- Parameters:
map
- the map to decorate, must not be nullkeyTransformer
- the transformer to use for key conversion, null means no transformationvalueTransformer
- 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)
Deprecated.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(java.util.Map, org.apache.commons.collections.Transformer, org.apache.commons.collections.Transformer)
.- Parameters:
map
- the map to decorate, must not be nullkeyTransformer
- the transformer to use for key conversion, null means no transformationvalueTransformer
- the transformer to use for value conversion, null means no transformation- Throws:
IllegalArgumentException
- if map is null- Since:
- Commons Collections 3.2
-
put
public Object put(Object key, Object value)
Deprecated.- Specified by:
put
in interfaceMap
- Overrides:
put
in classAbstractMapDecorator
-
putAll
public void putAll(Map mapToCopy)
Deprecated.- Specified by:
putAll
in interfaceMap
- Overrides:
putAll
in classAbstractMapDecorator
-
entrySet
public Set entrySet()
Deprecated.- Specified by:
entrySet
in interfaceMap
- Overrides:
entrySet
in classAbstractMapDecorator
-
-