public class PredicatedMap<K,V> extends AbstractMapDecorator<K ,V> implements Serializable
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. This class may throw exceptions when accessed by concurrent threads without synchronization.
This class is Serializable from Commons Collections 3.1.
| Modifier and Type | Field and Description |
|---|---|
protected Predicate |
keyPredicate
The key predicate to use
|
protected Predicate |
valuePredicate
The value predicate to use
|
| Modifier | Constructor and Description |
|---|---|
protected |
PredicatedMap(Map
Constructor that wraps (not copies).
|
| Modifier and Type | Method and Description |
|---|---|
protected V |
checkSetValue(V value)
Override to validate an object set into the map via
setValue.
|
Set |
entrySet()
|
protected boolean |
isSetValueChecking()
Override to only return true when there is a value transformer.
|
static <K |
predicatedMap(Map
Factory method to create a predicated (validating) map.
|
V |
put(K key, V value)
Note that the return type is Object, rather than V as in the Map interface.
|
void |
putAll(Map
|
protected void |
validate(K key, V value)
Validates a key value pair.
|
clear, containsKey, containsValue, decorated, equals, get, hashCode, isEmpty, keySet, remove, size, toString, valuesmapIteratorclone, finalize, getClass, notify, notifyAll, wait, wait, waitcompute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAllprotected PredicatedMap(Map<K ,V> map, Predicate <? super K> keyPredicate, Predicate <? super V> valuePredicate)
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
NullPointerException - if the map is null
public static <K,V> PredicatedMap <K ,V> predicatedMap(Map <K ,V> map, Predicate <? super K> keyPredicate, Predicate <? super V> valuePredicate)
If there are any elements already in the list being decorated, they are validated.
K - the key type
V - the value type
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
NullPointerException - if the map is null
protected void validate(K key, V value)
key - the key to validate
value - the value to validate
IllegalArgumentException - if invalid
protected V checkSetValue(V value)
setValue.
value - the value to validate
IllegalArgumentException - if invalid
protected boolean isSetValueChecking()
public V put(K key, V value)
Put
public Set<Map .Entry <K ,V>> entrySet()
entrySet in interface
Map<K,V>
entrySet in interface
Get<K,V>
entrySet in class
AbstractMapDecorator<K,V>
Map.entrySet()