Class TransformedSortedMap<K,V>
- java.lang.Object
-
- org.apache.commons.collections4.map.AbstractIterableMap<K,V>
-
- org.apache.commons.collections4.map.AbstractMapDecorator<K,V>
-
- org.apache.commons.collections4.map.AbstractInputCheckedMapDecorator<K,V>
-
- org.apache.commons.collections4.map.TransformedMap<K,V>
-
- org.apache.commons.collections4.map.TransformedSortedMap<K,V>
-
- Type Parameters:
K
- the type of the keys in this mapV
- the type of the values in this map
- All Implemented Interfaces:
java.io.Serializable
,java.util.Map<K,V>
,java.util.SortedMap<K,V>
,Get<K,V>
,IterableGet<K,V>
,IterableMap<K,V>
,Put<K,V>
public class TransformedSortedMap<K,V> extends TransformedMap<K,V> implements java.util.SortedMap<K,V>
Decorates anotherSortedMap
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:
- 3.0
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private static long
serialVersionUID
Serialization version-
Fields inherited from class org.apache.commons.collections4.map.TransformedMap
keyTransformer, valueTransformer
-
Fields inherited from class org.apache.commons.collections4.map.AbstractMapDecorator
map
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
TransformedSortedMap(java.util.SortedMap<K,V> map, Transformer<? super K,? extends K> keyTransformer, Transformer<? super V,? extends V> valueTransformer)
Constructor that wraps (not copies).
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Comparator<? super K>
comparator()
K
firstKey()
protected java.util.SortedMap<K,V>
getSortedMap()
Gets the map being decorated.java.util.SortedMap<K,V>
headMap(K toKey)
K
lastKey()
java.util.SortedMap<K,V>
subMap(K fromKey, K toKey)
java.util.SortedMap<K,V>
tailMap(K fromKey)
static <K,V>
TransformedSortedMap<K,V>transformedSortedMap(java.util.SortedMap<K,V> map, Transformer<? super K,? extends K> keyTransformer, Transformer<? super V,? extends V> valueTransformer)
Factory method to create a transforming sorted map that will transform existing contents of the specified map.static <K,V>
TransformedSortedMap<K,V>transformingSortedMap(java.util.SortedMap<K,V> map, Transformer<? super K,? extends K> keyTransformer, Transformer<? super V,? extends V> valueTransformer)
Factory method to create a transforming sorted map.-
Methods inherited from class org.apache.commons.collections4.map.TransformedMap
checkSetValue, isSetValueChecking, put, putAll, transformedMap, transformingMap, transformKey, transformMap, transformValue
-
Methods inherited from class org.apache.commons.collections4.map.AbstractInputCheckedMapDecorator
entrySet
-
Methods inherited from class org.apache.commons.collections4.map.AbstractMapDecorator
clear, containsKey, containsValue, decorated, equals, get, hashCode, isEmpty, keySet, remove, size, toString, values
-
Methods inherited from class org.apache.commons.collections4.map.AbstractIterableMap
mapIterator
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
Serialization version- See Also:
- Constant Field Values
-
-
Constructor Detail
-
TransformedSortedMap
protected TransformedSortedMap(java.util.SortedMap<K,V> map, Transformer<? super K,? extends K> keyTransformer, Transformer<? super V,? extends V> 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:
java.lang.NullPointerException
- if the map is null
-
-
Method Detail
-
transformingSortedMap
public static <K,V> TransformedSortedMap<K,V> transformingSortedMap(java.util.SortedMap<K,V> map, Transformer<? super K,? extends K> keyTransformer, Transformer<? super V,? extends V> valueTransformer)
Factory method to create a transforming sorted map.If there are any elements already in the map being decorated, they are NOT transformed. Contrast this with
transformedSortedMap(SortedMap, Transformer, Transformer)
.- Type Parameters:
K
- the key typeV
- the value type- 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- Returns:
- a new transformed sorted map
- Throws:
java.lang.NullPointerException
- if the map is null- Since:
- 4.0
-
transformedSortedMap
public static <K,V> TransformedSortedMap<K,V> transformedSortedMap(java.util.SortedMap<K,V> map, Transformer<? super K,? extends K> keyTransformer, Transformer<? super V,? extends V> 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. Contrast this with
transformingSortedMap(SortedMap, Transformer, Transformer)
.- Type Parameters:
K
- the key typeV
- the value type- 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- Returns:
- a new transformed sorted map
- Throws:
java.lang.NullPointerException
- if map is null- Since:
- 4.0
-
getSortedMap
protected java.util.SortedMap<K,V> getSortedMap()
Gets the map being decorated.- Returns:
- the decorated map
-
comparator
public java.util.Comparator<? super K> comparator()
-
-