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.
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() |
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) |
decorate, put, putAll
clear, containsKey, containsValue, equals, get, hashCode, isEmpty, keySet, remove, size, toString, values
public 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 nullpublic java.lang.Object firstKey()
firstKey
in interface java.util.SortedMap
public java.lang.Object lastKey()
lastKey
in interface java.util.SortedMap
public 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.SortedMap
public java.util.SortedMap headMap(java.lang.Object toKey)
headMap
in interface java.util.SortedMap
public java.util.SortedMap tailMap(java.lang.Object fromKey)
tailMap
in interface java.util.SortedMap
public java.util.Set entrySet()
entrySet
in interface java.util.Map
entrySet
in class AbstractMapDecorator
Copyright © 2010 - 2020 Adobe. All Rights Reserved