Package org.apache.commons.collections.map

Class TransformedSortedMap

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

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.util.Comparator comparator()
      Deprecated.
       
      static java.util.SortedMap decorate​(java.util.SortedMap map, Transformer keyTransformer, Transformer valueTransformer)
      Deprecated.
      Factory method to create a transforming sorted map.
      static java.util.SortedMap decorateTransform​(java.util.SortedMap map, Transformer keyTransformer, Transformer valueTransformer)
      Deprecated.
      Factory method to create a transforming sorted map that will transform existing contents of the specified map.
      java.util.Set entrySet()
      Deprecated.
       
      java.lang.Object firstKey()
      Deprecated.
       
      java.util.SortedMap headMap​(java.lang.Object toKey)
      Deprecated.
       
      java.lang.Object lastKey()
      Deprecated.
       
      java.util.SortedMap subMap​(java.lang.Object fromKey, java.lang.Object toKey)
      Deprecated.
       
      java.util.SortedMap tailMap​(java.lang.Object fromKey)
      Deprecated.
       

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Map

        clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size

      • Methods inherited from interface java.util.SortedMap

        entrySet, keySet, values

    • Method Detail

      • decorateTransform

        public static java.util.SortedMap decorateTransform​(java.util.SortedMap map,
                                                    Transformer keyTransformer,
                                                    Transformer valueTransformer)
        Deprecated.
        Factory method to create a transforming sorted 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.SortedMap, 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

      • firstKey

        public java.lang.Object firstKey()
        Deprecated.
        Specified by:
        firstKey in interface java.util.SortedMap

      • lastKey

        public java.lang.Object lastKey()
        Deprecated.
        Specified by:
        lastKey in interface java.util.SortedMap

      • comparator

        public java.util.Comparator comparator()
        Deprecated.
        Specified by:
        comparator in interface java.util.SortedMap

      • subMap

        public java.util.SortedMap subMap​(java.lang.Object fromKey,
                                  java.lang.Object toKey)
        Deprecated.
        Specified by:
        subMap in interface java.util.SortedMap

      • headMap

        public java.util.SortedMap headMap​(java.lang.Object toKey)
        Deprecated.
        Specified by:
        headMap in interface java.util.SortedMap

      • tailMap

        public java.util.SortedMap tailMap​(java.lang.Object fromKey)
        Deprecated.
        Specified by:
        tailMap in interface java.util.SortedMap

      • entrySet

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