Package org.apache.commons.collections.map

Class TransformedMap

  • All Implemented Interfaces:
    java.io.Serializable, java.util.Map
    Direct Known Subclasses:
    TransformedSortedMap
    @Deprecated(since="2021-04-30")
public class TransformedMap
extends AbstractMapDecorator
implements java.io.Serializable
    Deprecated.
    Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.
    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.

    Since:
    Commons Collections 3.0
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Method Detail

      • decorate

        public static java.util.Map decorate​(java.util.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 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
        Throws:
        java.lang.IllegalArgumentException - if map is null

      • decorateTransform

        public static java.util.Map decorateTransform​(java.util.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 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
        Throws:
        java.lang.IllegalArgumentException - if map is null
        Since:
        Commons Collections 3.2

      • put

        public java.lang.Object put​(java.lang.Object key,
                            java.lang.Object value)
        Deprecated.
        Specified by:
        put in interface java.util.Map
        Overrides:
        put in class AbstractMapDecorator

      • putAll

        public void putAll​(java.util.Map mapToCopy)
        Deprecated.
        Specified by:
        putAll in interface java.util.Map
        Overrides:
        putAll in class AbstractMapDecorator

      • entrySet

        public java.util.Set entrySet()
        Deprecated.
        Specified by:
        entrySet in interface java.util.Map
        Overrides:
        entrySet in class AbstractMapDecorator