⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
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:
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.

Since:
Commons Collections 3.0
Author:
Stephen Colebourne

Constructor Summary

TransformedSortedMap(SortedMap map, Transformer keyTransformer, Transformer valueTransformer)

Constructor that wraps (not copies).

Method Summary

Comparator

comparator()

static SortedMap

decorate(SortedMap map, Transformer keyTransformer, Transformer valueTransformer)

Factory method to create a transforming sorted map.

Object

firstKey()

SortedMap

getSortedMap()

Gets the map being decorated.

SortedMap

headMap(Object toKey)

Object

lastKey()

SortedMap

subMap(Object fromKey, Object toKey)

SortedMap

tailMap(Object fromKey)

Constructor Details

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:
- if the map is null

Method Details

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.

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:
- if the map is null

firstKey

public Object firstKey()


getSortedMap

protected SortedMap getSortedMap()

Gets the map being decorated.

Returns:
the decorated map

headMap

public SortedMap headMap(Object toKey)

Parameters:
toKey

lastKey

public Object lastKey()


subMap

public SortedMap subMap(Object fromKey, Object toKey)

Parameters:
fromKey
toKey

tailMap

public SortedMap tailMap(Object fromKey)

Parameters:
fromKey