|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.collections4.splitmap.AbstractIterableGetMapDecorator<K,V>
org.apache.commons.collections4.splitmap.TransformedSplitMap<J,K,U,V>
public class TransformedSplitMap<J,K,U,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.
The "put" and "get" type constraints of this class are mutually independent;
contrast with TransformedMap
which,
by virtue of its implementing Map
<K, V>, must be constructed in such
a way that its read and write parameters are generalized to a common (super-)type.
In practice this would often mean >Object, Object>
, defeating
much of the usefulness of having parameterized types.
On the downside, this class is not drop-in compatible with Map
but is intended to be worked with either directly or by Put
and
Get
generalizations.
SplitMapUtils.readableMap(Get)
,
SplitMapUtils.writableMap(Put)
,
Serialized FormConstructor Summary | |
---|---|
protected |
TransformedSplitMap(Map<K,V> map,
Transformer<? super J,? extends K> keyTransformer,
Transformer<? super U,? extends V> valueTransformer)
Constructor that wraps (not copies). |
Method Summary | ||
---|---|---|
protected V |
checkSetValue(U value)
Override to transform the value when using setValue . |
|
void |
clear()
|
|
V |
put(J key,
U value)
Note that the return type is Object, rather than V as in the Map interface. |
|
void |
putAll(Map<? extends J,? extends U> mapToCopy)
|
|
static
|
transformingMap(Map<K,V> map,
Transformer<? super J,? extends K> keyTransformer,
Transformer<? super U,? extends V> valueTransformer)
Factory method to create a transforming map. |
|
protected K |
transformKey(J object)
Transforms a key. |
|
protected Map<K,V> |
transformMap(Map<? extends J,? extends U> map)
Transforms a map. |
|
protected V |
transformValue(U object)
Transforms a value. |
Methods inherited from class org.apache.commons.collections4.splitmap.AbstractIterableGetMapDecorator |
---|
containsKey, containsValue, decorated, entrySet, equals, get, hashCode, isEmpty, keySet, mapIterator, remove, size, toString, values |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected TransformedSplitMap(Map<K,V> map, Transformer<? super J,? extends K> keyTransformer, Transformer<? super U,? 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 <J,K,U,V> TransformedSplitMap<J,K,U,V> transformingMap(Map<K,V> map, Transformer<? super J,? extends K> keyTransformer, Transformer<? super U,? extends V> valueTransformer)
If there are any elements already in the map being decorated, they are NOT transformed.
J
- the input key typeK
- the output key typeU
- the input value typeV
- the output 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(J object)
The transformer itself may throw an exception if necessary.
object
- the object to transform
protected V transformValue(U object)
The transformer itself may throw an exception if necessary.
object
- the object to transform
protected Map<K,V> transformMap(Map<? extends J,? extends U> map)
The transformer itself may throw an exception if necessary.
map
- the map to transform
protected V checkSetValue(U value)
setValue
.
value
- the value to transform
public V put(J key, U value)
Put
put
in interface Put<J,U>
Map.put(Object, Object)
public void putAll(Map<? extends J,? extends U> mapToCopy)
putAll
in interface Put<J,U>
Map.putAll(Map)
public void clear()
clear
in interface Put<J,U>
Map.clear()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |