org.apache.commons.collections.map

Class TransformedSortedMap

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 java.util.Collections#synchronizedSortedMap. 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: 348013 $ $Date: 2005-11-21 23:24:45 +0000 (Mon, 21 Nov 2005) $

Author: Stephen Colebourne

Constructor Summary
protected TransformedSortedMap(SortedMap map, Transformer keyTransformer, Transformer valueTransformer)
Constructor that wraps (not copies).
Method Summary
Comparatorcomparator()
static SortedMapdecorate(SortedMap map, Transformer keyTransformer, Transformer valueTransformer)
Factory method to create a transforming sorted map.
static SortedMapdecorateTransform(SortedMap map, Transformer keyTransformer, Transformer valueTransformer)
Factory method to create a transforming sorted map that will transform existing contents of the specified map.
ObjectfirstKey()
protected SortedMapgetSortedMap()
Gets the map being decorated.
SortedMapheadMap(Object toKey)
ObjectlastKey()
SortedMapsubMap(Object fromKey, Object toKey)
SortedMaptailMap(Object fromKey)

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

comparator

public Comparator comparator()

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 TransformedSortedMap.

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 TransformedSortedMap.

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

firstKey

public Object firstKey()

getSortedMap

protected SortedMap getSortedMap()
Gets the map being decorated.

Returns: the decorated map

headMap

public SortedMap headMap(Object toKey)

lastKey

public Object lastKey()

subMap

public SortedMap subMap(Object fromKey, Object toKey)

tailMap

public SortedMap tailMap(Object fromKey)
Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.