public class PredicatedMap<K,V> extends AbstractInputCheckedMapDecorator<K,V> implements java.io.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.synchronizedMap(Map)
. 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<? super K> |
keyPredicate
The key predicate to use
|
private static long |
serialVersionUID
Serialization version
|
protected Predicate<? super V> |
valuePredicate
The value predicate to use
|
map
Modifier | Constructor and Description |
---|---|
protected |
PredicatedMap(java.util.Map<K,V> map,
Predicate<? super K> keyPredicate,
Predicate<? super V> valuePredicate)
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 . |
protected boolean |
isSetValueChecking()
Override to only return true when there is a value transformer.
|
static <K,V> PredicatedMap<K,V> |
predicatedMap(java.util.Map<K,V> map,
Predicate<? super K> keyPredicate,
Predicate<? super V> valuePredicate)
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(java.util.Map<? extends K,? extends V> mapToCopy) |
private void |
readObject(java.io.ObjectInputStream in)
Read the map in using a custom routine.
|
protected void |
validate(K key,
V value)
Validates a key value pair.
|
private void |
writeObject(java.io.ObjectOutputStream out)
Write the map out using a custom routine.
|
entrySet
clear, containsKey, containsValue, decorated, equals, get, hashCode, isEmpty, keySet, remove, size, toString, values
mapIterator
private static final long serialVersionUID
protected PredicatedMap(java.util.Map<K,V> map, Predicate<? super K> keyPredicate, Predicate<? super V> valuePredicate)
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 static <K,V> PredicatedMap<K,V> predicatedMap(java.util.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 typeV
- the value typemap
- 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 nullprivate void writeObject(java.io.ObjectOutputStream out) throws java.io.IOException
out
- the output streamjava.io.IOException
private void readObject(java.io.ObjectInputStream in) throws java.io.IOException, java.lang.ClassNotFoundException
in
- the input streamjava.io.IOException
java.lang.ClassNotFoundException
protected void validate(K key, V value)
key
- the key to validatevalue
- the value to validatejava.lang.IllegalArgumentException
- if invalidprotected V checkSetValue(V value)
setValue
.checkSetValue
in class AbstractInputCheckedMapDecorator<K,V>
value
- the value to validatejava.lang.IllegalArgumentException
- if invalidprotected boolean isSetValueChecking()
isSetValueChecking
in class AbstractInputCheckedMapDecorator<K,V>
public V put(K key, V value)
Put