java.lang.Object | ||
↳ | org.apache.commons.collections.map.AbstractMapDecorator | |
↳ | org.apache.commons.collections.map.TransformedMap |
Known Direct Subclasses |
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 synchronizedMap(Map)
. This class may throw
exceptions when accessed by concurrent threads without synchronization.
This class is Serializable from Commons Collections 3.1.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
keyTransformer | The transformer to use for the key | ||||||||||
valueTransformer | The transformer to use for the value |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.commons.collections.map.AbstractMapDecorator
|
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructor that wraps (not copies).
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Factory method to create a transforming map.
| |||||||||||
Factory method to create a transforming map that will transform
existing contents of the specified map.
| |||||||||||
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Override to transform the value when using
setValue . | |||||||||||
Override to only return true when there is a value transformer.
| |||||||||||
Transforms a key.
| |||||||||||
Transforms a map.
| |||||||||||
Transforms a value.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.commons.collections.map.AbstractMapDecorator
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.util.Map
|
Constructor that wraps (not copies).
If there are any elements already in the collection being decorated, they are NOT transformed.
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 |
IllegalArgumentException | if map is null |
---|
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(Map, Transformer, Transformer)
.
map | the map to decorate, must not be null |
---|---|
keyTransformer | the transformer to use for key conversion, null means no transformation |
valueTransformer | the transformer to use for value conversion, null means no transformation |
IllegalArgumentException | if map is null |
---|
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(Map, Transformer, Transformer)
.
map | the map to decorate, must not be null |
---|---|
keyTransformer | the transformer to use for key conversion, null means no transformation |
valueTransformer | the transformer to use for value conversion, null means no transformation |
IllegalArgumentException | if map is null |
---|
Override to transform the value when using setValue
.
value | the value to transform |
---|
Override to only return true when there is a value transformer.
Transforms a key.
The transformer itself may throw an exception if necessary.
object | the object to transform |
---|
transformed object |
Transforms a map.
The transformer itself may throw an exception if necessary.
map | the map to transform |
---|
transformed object |
Transforms a value.
The transformer itself may throw an exception if necessary.
object | the object to transform |
---|
transformed object |