Class TransformedSortedMap
- All Implemented Interfaces:
Serializable,Map,SortedMap
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<K, V>). 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:
-
Nested Class Summary
-
Field Summary
Fields inherited from class org.apache.commons.collections.map.TransformedMap
keyTransformer, valueTransformerFields inherited from class org.apache.commons.collections.map.AbstractMapDecorator
map -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedTransformedSortedMap(SortedMap map, Transformer keyTransformer, Transformer valueTransformer) Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionstatic 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.entrySet()firstKey()protected SortedMapGets the map being decorated.lastKey()Methods inherited from class org.apache.commons.collections.map.TransformedMap
checkSetValue, decorate, decorateTransform, isSetValueChecking, put, putAll, transformKey, transformMap, transformValueMethods inherited from class org.apache.commons.collections.map.AbstractMapDecorator
clear, containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, keySet, remove, size, toString, valuesMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size
-
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 nullkeyTransformer- the predicate to validate the keys, null means no transformationvalueTransformer- the predicate to validate to values, null means no transformation- Throws:
IllegalArgumentException- if the map is null
-
-
Method Details
-
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 nullkeyTransformer- the predicate to validate the keys, null means no transformationvalueTransformer- 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 nullkeyTransformer- the transformer to use for key conversion, null means no transformationvalueTransformer- the transformer to use for value conversion, null means no transformation- Throws:
IllegalArgumentException- if map is null- Since:
- Commons Collections 3.2
-
getSortedMap
Gets the map being decorated.- Returns:
- the decorated map
-
firstKey
-
lastKey
-
comparator
- Specified by:
comparatorin interfaceSortedMap
-
subMap
-
headMap
-
tailMap
-
entrySet
- Specified by:
entrySetin interfaceMap- Overrides:
entrySetin classAbstractMapDecorator
-