org.apache.commons.collections.map

Class TransformedSortedMap

Implemented Interfaces:
Map, Serializable, 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.

This class is Serializable from Commons Collections 3.1.

Version:
$Revision: 1.6 $ $Date: 2004/04/09 10:36:01 $
Author:
Stephen Colebourne
Since:
Commons Collections 3.0

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

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()
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, isSetValueChecking, put, putAll, transformKey, transformMap, transformValue

Methods inherited from class org.apache.commons.collections.map.AbstractInputCheckedMapDecorator

checkSetValue, entrySet, isSetValueChecking

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

clear, containsKey, containsValue, entrySet, equals, get, getMap, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values

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

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

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-2006 Apache Software Foundation. All Rights Reserved.