public class PredicatedSortedMap extends PredicatedMap implements java.util.SortedMap
SortedMap to validate that additions
match a specified predicate.
This map exists to provide validation for the decorated map. It is normally created to decorate an empty map. If an object cannot be added to the map, an IllegalArgumentException is thrown.
One usage would be to ensure that no null keys are added to the map.
SortedMap map = PredicatedSortedSet.decorate(new TreeMap(), NotNullPredicate.INSTANCE, null);
Note that PredicatedSortedMap 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.
keyPredicate, valuePredicatemap| Modifier | Constructor and Description |
|---|---|
protected |
PredicatedSortedMap(java.util.SortedMap map,
Predicate keyPredicate,
Predicate valuePredicate)
Constructor that wraps (not copies).
|
| Modifier and Type | Method and Description |
|---|---|
java.util.Comparator |
comparator() |
static java.util.SortedMap |
decorate(java.util.SortedMap map,
Predicate keyPredicate,
Predicate valuePredicate)
Factory method to create a predicated (validating) sorted 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) |
checkSetValue, decorate, isSetValueChecking, put, putAll, validateclear, containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, keySet, remove, size, toString, valuesprotected PredicatedSortedMap(java.util.SortedMap map,
Predicate keyPredicate,
Predicate valuePredicate)
map - the map to decorate, must not be nullkeyPredicate - the predicate to validate the keys, null means no checkvaluePredicate - the predicate to validate to values, null means no checkjava.lang.IllegalArgumentException - if the map is nullpublic static java.util.SortedMap decorate(java.util.SortedMap map,
Predicate keyPredicate,
Predicate valuePredicate)
If there are any elements already in the list being decorated, they are validated.
map - the map to decorate, must not be nullkeyPredicate - the predicate to validate the keys, null means no checkvaluePredicate - the predicate to validate to values, null means no checkjava.lang.IllegalArgumentException - if the 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.SortedMappublic 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 AbstractMapDecoratorCopyright © 2001-2025 Apache Software Foundation. All Rights Reserved.