Class PredicatedMap<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> - Get<K,,- V> - IterableGet<K,,- V> - IterableMap<K,,- V> - Put<K,- V> 
- Direct Known Subclasses:
- PredicatedSortedMap
Map 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.
Map map = PredicatedSet.decorate(new HashMap(), NotNullPredicate.INSTANCE, null);
 Note that PredicatedMap 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.synchronizedMap(Map). 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 SummaryFieldsModifier and TypeFieldDescriptionThe key predicate to useThe value predicate to use
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected VcheckSetValue(V value) Override to validate an object set into the map viasetValue.entrySet()Gets a set view of the mappings contained in this map.protected booleanOverride to only return true when there is a value transformer.static <K,V> PredicatedMap <K, V> predicatedMap(Map<K, V> map, Predicate<? super K> keyPredicate, Predicate<? super V> valuePredicate) Factory method to create a predicated (validating) map.Associates the specified value with the specified key in this map.voidCopies all of the mappings from the specified map to this map.protected voidValidates a key value pair.Methods 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.Mapcompute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
- 
Field Details- 
keyPredicateThe key predicate to use
- 
valuePredicateThe value predicate to use
 
- 
- 
Constructor Details- 
PredicatedMapprotected PredicatedMap(Map<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- 
predicatedMappublic static <K,V> PredicatedMap<K,V> predicatedMap(Map<K, V> map, Predicate<? super K> keyPredicate, Predicate<? super V> valuePredicate) Factory method to create a predicated (validating) 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 map
- Throws:
- NullPointerException- if the map is null
- Since:
- 4.0
 
- 
checkSetValueOverride to validate an object set into the map viasetValue.- Parameters:
- value- the value to validate
- Returns:
- the value itself
- Throws:
- IllegalArgumentException- if invalid
- Since:
- 3.1
 
- 
isSetValueCheckingOverride to only return true when there is a value transformer.- Returns:
- true if a value predicate is in use
- Since:
- 3.1
 
- 
putDescription copied from interface:PutAssociates the specified value with the specified key in this map.Note that the return type is Object, rather than V as in the Map interface. See the class Javadoc for further info. - Specified by:
- putin interface- Map<K,- V> 
- Specified by:
- putin interface- Put<K,- V> 
- Overrides:
- putin class- AbstractMapDecorator<K,- V> 
- Parameters:
- key- key with which the specified value is to be associated
- value- value to be associated with the specified key
- Returns:
- the previous value associated with key, ornullif there was no mapping forkey. (Anullreturn can also indicate that the map previously associatednullwithkey, if the implementation supportsnullvalues.)
- See Also:
 
- 
putAllDescription copied from interface:PutCopies all of the mappings from the specified map to this map.
- 
validateValidates a key value pair.- Parameters:
- key- the key to validate
- value- the value to validate
- Throws:
- IllegalArgumentException- if invalid
 
- 
entrySetDescription copied from interface:GetGets a set view of the mappings contained in this map.
 
-