|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.collections4.map.AbstractIterableMap<K,V>
org.apache.commons.collections4.map.AbstractMapDecorator<K,V>
org.apache.commons.collections4.map.TransformedMap<K,V>
org.apache.commons.collections4.map.TransformedSortedMap<K,V>
public class TransformedSortedMap<K,V>
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 Collections.synchronizedSortedMap(java.util.SortedMap
. This class may throw
exceptions when accessed by concurrent threads without synchronization.
This class is Serializable from Commons Collections 3.1.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface java.util.Map |
---|
Map.Entry<K,V> |
Field Summary |
---|
Fields inherited from class org.apache.commons.collections4.map.TransformedMap |
---|
keyTransformer, valueTransformer |
Constructor Summary | |
---|---|
protected |
TransformedSortedMap(SortedMap<K,V> map,
Transformer<? super K,? extends K> keyTransformer,
Transformer<? super V,? extends V> valueTransformer)
Constructor that wraps (not copies). |
Method Summary | ||
---|---|---|
Comparator<? super K> |
comparator()
|
|
Set<Map.Entry<K,V>> |
entrySet()
|
|
K |
firstKey()
|
|
protected SortedMap<K,V> |
getSortedMap()
Gets the map being decorated. |
|
SortedMap<K,V> |
headMap(K toKey)
|
|
K |
lastKey()
|
|
SortedMap<K,V> |
subMap(K fromKey,
K toKey)
|
|
SortedMap<K,V> |
tailMap(K fromKey)
|
|
static
|
transformedSortedMap(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
|
transformingSortedMap(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.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 |
Methods inherited from interface java.util.Map |
---|
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values |
Constructor Detail |
---|
protected TransformedSortedMap(SortedMap<K,V> map, Transformer<? super K,? extends K> keyTransformer, Transformer<? super V,? extends V> valueTransformer)
If there are any elements already in the collection being decorated, they are NOT transformed.
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
IllegalArgumentException
- if the map is nullMethod Detail |
---|
public static <K,V> TransformedSortedMap<K,V> transformingSortedMap(SortedMap<K,V> map, Transformer<? super K,? extends K> keyTransformer, Transformer<? super V,? extends V> valueTransformer)
If there are any elements already in the map being decorated, they are NOT transformed.
Contrast this with transformedSortedMap(SortedMap, Transformer, Transformer)
.
K
- the key typeV
- the value typemap
- 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
IllegalArgumentException
- if the map is nullpublic static <K,V> TransformedSortedMap<K,V> transformedSortedMap(SortedMap<K,V> map, Transformer<? super K,? extends K> keyTransformer, Transformer<? super V,? extends V> valueTransformer)
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)
.
K
- the key typeV
- the value typemap
- 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
IllegalArgumentException
- if map is nullprotected SortedMap<K,V> getSortedMap()
public K firstKey()
firstKey
in interface SortedMap<K,V>
public K lastKey()
lastKey
in interface SortedMap<K,V>
public Comparator<? super K> comparator()
comparator
in interface SortedMap<K,V>
public SortedMap<K,V> subMap(K fromKey, K toKey)
subMap
in interface SortedMap<K,V>
public SortedMap<K,V> headMap(K toKey)
headMap
in interface SortedMap<K,V>
public SortedMap<K,V> tailMap(K fromKey)
tailMap
in interface SortedMap<K,V>
public Set<Map.Entry<K,V>> entrySet()
entrySet
in interface Map<K,V>
entrySet
in interface Get<K,V>
entrySet
in class AbstractMapDecorator<K,V>
Map.entrySet()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |