public class PredicatedMap extends AbstractMapDecorator 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.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 |
keyPredicate
The key predicate to use
|
protected Predicate |
valuePredicate
The value predicate to use
|
map| Modifier | Constructor and Description |
|---|---|
protected |
PredicatedMap(Map map,
Predicate keyPredicate,
Predicate valuePredicate)
Constructor that wraps (not copies).
|
| Modifier and Type | Method and Description |
|---|---|
protected Object |
checkSetValue(Object value)
Override to validate an object set into the map via
setValue. |
static Map |
decorate(Map map,
Predicate keyPredicate,
Predicate valuePredicate)
Factory method to create a predicated (validating) map.
|
Set |
entrySet() |
protected boolean |
isSetValueChecking()
Override to only return true when there is a value transformer.
|
Object |
put(Object key,
Object value) |
void |
putAll(Map mapToCopy) |
protected void |
validate(Object key,
Object value)
Validates a key value pair.
|
clear, containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, keySet, remove, size, toString, valuesprotected final Predicate keyPredicate
protected final Predicate valuePredicate
protected PredicatedMap(Map map, Predicate keyPredicate, Predicate 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 checkIllegalArgumentException - if the map is nullpublic static Map decorate(Map map, Predicate keyPredicate, Predicate valuePredicate)
If there are any elements already in the list being decorated, they are validated.
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 checkIllegalArgumentException - if the map is nullprotected void validate(Object key, Object value)
key - the key to validatevalue - the value to validateIllegalArgumentException - if invalidprotected Object checkSetValue(Object value)
setValue.value - the value to validateIllegalArgumentException - if invalidprotected boolean isSetValueChecking()
public Object put(Object key, Object value)
put in interface Mapput in class AbstractMapDecoratorpublic void putAll(Map mapToCopy)
putAll in interface MapputAll in class AbstractMapDecoratorpublic Set entrySet()
entrySet in interface MapentrySet in class AbstractMapDecoratorCopyright © 2001–2015 The Apache Software Foundation. All rights reserved.