|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.collections4.map.AbstractIterableMap<K,V>
org.apache.commons.collections4.map.AbstractMapDecorator<K,V>
org.apache.commons.collections4.map.TransformedMap<K,V>
public class TransformedMap<K,V>
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 Collections.synchronizedMap(Map)
. This class may throw
exceptions when accessed by concurrent threads without synchronization.
This class is Serializable from Commons Collections 3.1.
TransformedSplitMap
,
Serialized FormNested Class Summary |
---|
Nested classes/interfaces inherited from interface java.util.Map |
---|
Map.Entry<K,V> |
Field Summary | |
---|---|
protected Transformer<? super K,? extends K> |
keyTransformer
The transformer to use for the key |
protected Transformer<? super V,? extends V> |
valueTransformer
The transformer to use for the value |
Constructor Summary | |
---|---|
protected |
TransformedMap(Map<K,V> map,
Transformer<? super K,? extends K> keyTransformer,
Transformer<? super V,? extends V> valueTransformer)
Constructor that wraps (not copies). |
Method Summary | ||
---|---|---|
protected V |
checkSetValue(V value)
Override to transform the value when using setValue . |
|
Set<Map.Entry<K,V>> |
entrySet()
|
|
protected boolean |
isSetValueChecking()
Override to only return true when there is a value transformer. |
|
V |
put(K key,
V value)
Note that the return type is Object, rather than V as in the Map interface. |
|
void |
putAll(Map<? extends K,? extends V> mapToCopy)
|
|
static
|
transformedMap(Map<K,V> map,
Transformer<? super K,? extends K> keyTransformer,
Transformer<? super V,? extends V> valueTransformer)
Factory method to create a transforming map that will transform existing contents of the specified map. |
|
static
|
transformingMap(Map<K,V> map,
Transformer<? super K,? extends K> keyTransformer,
Transformer<? super V,? extends V> valueTransformer)
Factory method to create a transforming map. |
|
protected K |
transformKey(K object)
Transforms a key. |
|
protected Map<K,V> |
transformMap(Map<? extends K,? extends V> map)
Transforms a map. |
|
protected V |
transformValue(V object)
Transforms a value. |
Methods inherited from class org.apache.commons.collections4.map.AbstractMapDecorator |
---|
clear, containsKey, containsValue, decorated, equals, get, hashCode, isEmpty, keySet, remove, size, toString, values |
Methods inherited from class org.apache.commons.collections4.map.AbstractIterableMap |
---|
mapIterator |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected final Transformer<? super K,? extends K> keyTransformer
protected final Transformer<? super V,? extends V> valueTransformer
Constructor Detail |
---|
protected TransformedMap(Map<K,V> map, Transformer<? super K,? extends K> keyTransformer, Transformer<? super V,? extends V> 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 conversion
IllegalArgumentException
- if map is nullMethod Detail |
---|
public static <K,V> TransformedMap<K,V> transformingMap(Map<K,V> map, Transformer<? super K,? extends K> keyTransformer, Transformer<? super V,? extends V> valueTransformer)
If there are any elements already in the map being decorated, they
are NOT transformed.
Contrast this with transformedMap(Map, Transformer, Transformer)
.
K
- the key typeV
- the value typemap
- 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
IllegalArgumentException
- if map is nullpublic static <K,V> TransformedMap<K,V> transformedMap(Map<K,V> map, Transformer<? super K,? extends K> keyTransformer, Transformer<? super V,? extends V> valueTransformer)
If there are any elements already in the map being decorated, they
will be transformed by this method.
Contrast this with transformingMap(Map, Transformer, Transformer)
.
K
- the key typeV
- the value typemap
- 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
IllegalArgumentException
- if map is nullprotected K transformKey(K object)
The transformer itself may throw an exception if necessary.
object
- the object to transform
protected V transformValue(V object)
The transformer itself may throw an exception if necessary.
object
- the object to transform
protected Map<K,V> transformMap(Map<? extends K,? extends V> map)
The transformer itself may throw an exception if necessary.
map
- the map to transform
protected V checkSetValue(V value)
setValue
.
value
- the value to transform
protected boolean isSetValueChecking()
public V put(K key, V value)
Put
put
in interface Map<K,V>
put
in interface Put<K,V>
put
in class AbstractMapDecorator<K,V>
Map.put(Object, Object)
public void putAll(Map<? extends K,? extends V> mapToCopy)
putAll
in interface Map<K,V>
putAll
in interface Put<K,V>
putAll
in class AbstractMapDecorator<K,V>
Map.putAll(Map)
public Set<Map.Entry<K,V>> entrySet()
entrySet
in interface Map<K,V>
entrySet
in interface Get<K,V>
entrySet
in class AbstractMapDecorator<K,V>
Map.entrySet()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |