org.apache.commons.collections.map

## Class TransformedSortedMap

- java.lang.Object
- - org.apache.commons.collections.map.AbstractMapDecorator
  - - org.apache.commons.collections.map.TransformedMap
    - - org.apache.commons.collections.map.TransformedSortedMap

- All Implemented Interfaces:
    Serializable, Map, SortedMap

      public class TransformedSortedMap
      extends TransformedMap
      implements SortedMap

  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)`. 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
  Version:
    $Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
  Author:
    Stephen Colebourne
  See Also:
    Serialized Form

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from interface java.util.Map

      `Map.Entry`

  - ### Field Summary

    - ### Fields inherited from class org.apache.commons.collections.map.TransformedMap

      `keyTransformer, valueTransformer`

    - ### Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator

      `map`

  - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `TransformedSortedMap(SortedMap map, Transformer keyTransformer, Transformer valueTransformer)` Constructor that wraps (not copies).

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `Comparator` | `comparator()`
    `static SortedMap` | `decorate(SortedMap map, Transformer keyTransformer, Transformer valueTransformer)` Factory method to create a transforming sorted map.
    `static SortedMap` | `decorateTransform(SortedMap map, Transformer keyTransformer, Transformer valueTransformer)` Factory method to create a transforming sorted map that will transform existing contents of the specified map.
    `Set` | `entrySet()`
    `Object` | `firstKey()`
    `protected SortedMap` | `getSortedMap()` Gets the map being decorated.
    `SortedMap` | `headMap(Object toKey)`
    `Object` | `lastKey()`
    `SortedMap` | `subMap(Object fromKey, Object toKey)`
    `SortedMap` | `tailMap(Object fromKey)`

    - ### Methods inherited from class org.apache.commons.collections.map.TransformedMap

      `checkSetValue, decorate, decorateTransform, isSetValueChecking, put, putAll, transformKey, transformMap, transformValue`

    - ### Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator

      `clear, containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, keySet, remove, size, toString, values`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

    - ### Methods inherited from interface java.util.SortedMap

      `entrySet, keySet, values`

    - ### Methods inherited from interface java.util.Map

      `clear, containsKey, containsValue, equals, get, hashCode, isEmpty, put, putAll, remove, size`

- - ### Constructor Detail

    - #### TransformedSortedMap

          protected TransformedSortedMap(SortedMap map,
                              Transformer keyTransformer,
                              Transformer valueTransformer)

      Constructor that wraps (not copies).

      If there are any elements already in the collection being decorated, they are NOT transformed.

      Parameters:
        `map` - the map to decorate, must not be null
        `keyTransformer` - the predicate to validate the keys, null means no transformation
        `valueTransformer` - the predicate to validate to values, null means no transformation
      Throws:
        `IllegalArgumentException` - if the map is null

  - ### Method Detail

    - #### decorate

          public static SortedMap decorate(SortedMap map,
                           Transformer keyTransformer,
                           Transformer valueTransformer)

      Factory method to create a transforming sorted map.

      If there are any elements already in the map being decorated, they are NOT transformed. Constrast this with `decorateTransform(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 predicate to validate the keys, null means no transformation
        `valueTransformer` - the predicate to validate to values, null means no transformation
      Throws:
        `IllegalArgumentException` - if the map is null

    - #### decorateTransform

          public static SortedMap decorateTransform(SortedMap map,
                                    Transformer keyTransformer,
                                    Transformer valueTransformer)

      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:
        `IllegalArgumentException` - if map is null
      Since:
        Commons Collections 3.2

    - #### getSortedMap

          protected SortedMap getSortedMap()

      Gets the map being decorated.
      Returns:
        the decorated map

    - #### firstKey

          public Object firstKey()

      Specified by:
        `firstKey` in interface `SortedMap`

    - #### lastKey

          public Object lastKey()

      Specified by:
        `lastKey` in interface `SortedMap`

    - #### comparator

          public Comparator comparator()

      Specified by:
        `comparator` in interface `SortedMap`

    - #### subMap

          public SortedMap subMap(Object fromKey,
                         Object toKey)

      Specified by:
        `subMap` in interface `SortedMap`

    - #### headMap

          public SortedMap headMap(Object toKey)

      Specified by:
        `headMap` in interface `SortedMap`

    - #### tailMap

          public SortedMap tailMap(Object fromKey)

      Specified by:
        `tailMap` in interface `SortedMap`

    - #### entrySet

          public Set entrySet()

      Specified by:
        `entrySet` in interface `Map`
      Overrides:
        `entrySet` in class `AbstractMapDecorator`

Copyright © 2001–2015 The Apache Software Foundation. All rights reserved.