Class PredicatedSortedMap
- java.lang.Object
-
- org.apache.commons.collections.map.AbstractMapDecorator
-
- org.apache.commons.collections.map.PredicatedMap
-
- org.apache.commons.collections.map.PredicatedSortedMap
-
- All Implemented Interfaces:
Serializable
,Map
,SortedMap
@Deprecated(since="2021-04-30") public class PredicatedSortedMap extends PredicatedMap implements SortedMap
Deprecated.Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.Decorates anotherSortedMap
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.
- Since:
- Commons Collections 3.0
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Comparator
comparator()
Deprecated.static SortedMap
decorate(SortedMap map, Predicate keyPredicate, Predicate valuePredicate)
Deprecated.Factory method to create a predicated (validating) sorted map.Set
entrySet()
Deprecated.Object
firstKey()
Deprecated.SortedMap
headMap(Object toKey)
Deprecated.Object
lastKey()
Deprecated.SortedMap
subMap(Object fromKey, Object toKey)
Deprecated.SortedMap
tailMap(Object fromKey)
Deprecated.-
Methods inherited from class org.apache.commons.collections.map.PredicatedMap
decorate, put, putAll
-
Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator
clear, containsKey, containsValue, equals, get, hashCode, isEmpty, keySet, remove, size, toString, values
-
Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size
-
-
-
-
Method Detail
-
decorate
public static SortedMap decorate(SortedMap map, Predicate keyPredicate, Predicate valuePredicate)
Deprecated.Factory method to create a predicated (validating) sorted map.If there are any elements already in the list being decorated, they are validated.
- Parameters:
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 check- Throws:
IllegalArgumentException
- if the map is null
-
comparator
public Comparator comparator()
Deprecated.- Specified by:
comparator
in interfaceSortedMap
-
entrySet
public Set entrySet()
Deprecated.- Specified by:
entrySet
in interfaceMap
- Overrides:
entrySet
in classAbstractMapDecorator
-
-