public class

TransformedSortedMap

extends TransformedMap
implements SortedMap<K, V>
java.lang.Object
   ↳ org.apache.commons.collections.map.AbstractMapDecorator
     ↳ org.apache.commons.collections.map.TransformedMap
       ↳ org.apache.commons.collections.map.TransformedSortedMap

Class Overview

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 synchronizedSortedMap(SortedMap). This class may throw exceptions when accessed by concurrent threads without synchronization.

This class is Serializable from Commons Collections 3.1.

Summary

[Expand]
Inherited Fields
From class org.apache.commons.collections.map.TransformedMap
From class org.apache.commons.collections.map.AbstractMapDecorator
Protected Constructors
TransformedSortedMap(SortedMap map, Transformer keyTransformer, Transformer valueTransformer)
Constructor that wraps (not copies).
Public Methods
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.
Object firstKey()
SortedMap headMap(Object toKey)
Object lastKey()
SortedMap subMap(Object fromKey, Object toKey)
SortedMap tailMap(Object fromKey)
Protected Methods
SortedMap getSortedMap()
Gets the map being decorated.
[Expand]
Inherited Methods
From class org.apache.commons.collections.map.TransformedMap
From class org.apache.commons.collections.map.AbstractMapDecorator
From class java.lang.Object
From interface java.util.Map
From interface java.util.SortedMap

Protected Constructors

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

Public Methods

public Comparator comparator ()

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(Map, Transformer, 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

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(Map, Transformer, 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

public Object firstKey ()

public SortedMap headMap (Object toKey)

public Object lastKey ()

public SortedMap subMap (Object fromKey, Object toKey)

public SortedMap tailMap (Object fromKey)

Protected Methods

protected SortedMap getSortedMap ()

Gets the map being decorated.

Returns
  • the decorated map