|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.collections.map.AbstractMapDecorator
org.apache.commons.collections.map.TransformedMap
org.apache.commons.collections.map.TransformedSortedMap
public class TransformedSortedMap
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 |
|---|
java.util.Map.Entry |
| 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 | |
|---|---|
protected |
TransformedSortedMap(java.util.SortedMap map,
Transformer keyTransformer,
Transformer valueTransformer)
Constructor that wraps (not copies). |
| Method Summary | |
|---|---|
java.util.Comparator |
comparator()
|
static java.util.SortedMap |
decorate(java.util.SortedMap map,
Transformer keyTransformer,
Transformer valueTransformer)
Factory method to create a transforming sorted map. |
static java.util.SortedMap |
decorateTransform(java.util.SortedMap map,
Transformer keyTransformer,
Transformer valueTransformer)
Factory method to create a transforming sorted map that will transform existing contents of the specified map. |
java.util.Set |
entrySet()
|
java.lang.Object |
firstKey()
|
protected java.util.SortedMap |
getSortedMap()
Gets the map being decorated. |
java.util.SortedMap |
headMap(java.lang.Object toKey)
|
java.lang.Object |
lastKey()
|
java.util.SortedMap |
subMap(java.lang.Object fromKey,
java.lang.Object toKey)
|
java.util.SortedMap |
tailMap(java.lang.Object fromKey)
|
| Methods inherited from class org.apache.commons.collections.map.TransformedMap |
|---|
checkSetValue, decorate, decorateTransform, isSetValueChecking, put, putAll, transformKey, transformMap, transformValue |
| Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator |
|---|
clear, containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, keySet, remove, size, toString, values |
| 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(java.util.SortedMap map,
Transformer keyTransformer,
Transformer 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
java.lang.IllegalArgumentException - if the map is null| Method Detail |
|---|
public static java.util.SortedMap decorate(java.util.SortedMap map,
Transformer keyTransformer,
Transformer valueTransformer)
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).
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
java.lang.IllegalArgumentException - if the map is null
public static java.util.SortedMap decorateTransform(java.util.SortedMap map,
Transformer keyTransformer,
Transformer valueTransformer)
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).
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
java.lang.IllegalArgumentException - if map is nullprotected java.util.SortedMap getSortedMap()
public java.lang.Object firstKey()
firstKey in interface java.util.SortedMappublic java.lang.Object lastKey()
lastKey in interface java.util.SortedMappublic java.util.Comparator comparator()
comparator in interface java.util.SortedMap
public java.util.SortedMap subMap(java.lang.Object fromKey,
java.lang.Object toKey)
subMap in interface java.util.SortedMappublic java.util.SortedMap headMap(java.lang.Object toKey)
headMap in interface java.util.SortedMappublic java.util.SortedMap tailMap(java.lang.Object fromKey)
tailMap in interface java.util.SortedMappublic java.util.Set entrySet()
entrySet in interface java.util.MapentrySet in class AbstractMapDecorator
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||