Class PredicatedSortedMap<K,V> 
- Type Parameters:
- K- the type of the keys in this map
- V- the type of the values in this map
- All Implemented Interfaces:
- Serializable,- Map<K,,- V> - SortedMap<K,,- V> - Get<K,,- V> - IterableGet<K,,- V> - IterableMap<K,,- V> - Put<K,- V> 
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 =
     PredicatedSortedMap.predicatedSortedMap(new TreeMap(),
                                             NotNullPredicate.notNullPredicate(),
                                             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:
- 3.0
- See Also:
- 
Nested Class Summary
- 
Field SummaryFields inherited from class org.apache.commons.collections4.map.PredicatedMapkeyPredicate, valuePredicate
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionComparator<? super K> entrySet()Gets a set view of the mappings contained in this map.firstKey()Gets the map being decorated.lastKey()static <K,V> PredicatedSortedMap <K, V> predicatedSortedMap(SortedMap<K, V> map, Predicate<? super K> keyPredicate, Predicate<? super V> valuePredicate) Factory method to create a predicated (validating) sorted map.Methods inherited from class org.apache.commons.collections4.map.PredicatedMapcheckSetValue, isSetValueChecking, predicatedMap, put, putAll, validateMethods inherited from class org.apache.commons.collections4.map.AbstractMapDecoratorclear, containsKey, containsValue, decorated, equals, get, hashCode, isEmpty, keySet, remove, size, toString, valuesMethods inherited from class org.apache.commons.collections4.map.AbstractIterableMapmapIteratorMethods inherited from class java.lang.Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Mapclear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size
- 
Constructor Details- 
PredicatedSortedMapprotected PredicatedSortedMap(SortedMap<K, V> map, Predicate<? super K> keyPredicate, Predicate<? super V> valuePredicate) Constructor that wraps (not copies).- Parameters:
- map- the map to decorate, must not be null
- keyPredicate- the predicate to validate the keys, null means no check
- valuePredicate- the predicate to validate to values, null means no check
- Throws:
- NullPointerException- if the map is null
 
 
- 
- 
Method Details- 
predicatedSortedMappublic static <K,V> PredicatedSortedMap<K,V> predicatedSortedMap(SortedMap<K, V> map, Predicate<? super K> keyPredicate, Predicate<? super V> valuePredicate) Factory method to create a predicated (validating) sorted map.If there are any elements already in the list being decorated, they are validated. - Type Parameters:
- K- the key type
- V- the value type
- Parameters:
- map- the map to decorate, must not be null
- keyPredicate- the predicate to validate the keys, null means no check
- valuePredicate- the predicate to validate to values, null means no check
- Returns:
- a new predicated sorted map
- Throws:
- NullPointerException- if the map is null
- Since:
- 4.0
 
- 
comparator- Specified by:
- comparatorin interface- SortedMap<K,- V> 
 
- 
firstKey
- 
getSortedMap
- 
headMap
- 
lastKey
- 
subMap
- 
tailMap
- 
entrySetDescription copied from interface:GetGets a set view of the mappings contained in this map.
 
-