org.apache.commons.collections.map
public class PredicatedMap extends AbstractInputCheckedMapDecorator 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 java.util.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: Commons Collections 3.0
Version: $Revision: 348007 $ $Date: 2005-11-21 22:52:57 +0000 (Mon, 21 Nov 2005) $
Field Summary | |
---|---|
protected Predicate | keyPredicate The key predicate to use |
protected Predicate | valuePredicate The value predicate to use |
Constructor Summary | |
---|---|
protected | PredicatedMap(Map map, Predicate keyPredicate, Predicate valuePredicate)
Constructor that wraps (not copies).
|
Method Summary | |
---|---|
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.
|
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.
|
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: IllegalArgumentException if the map is null
setValue
.
Parameters: value the value to validate
Throws: IllegalArgumentException if invalid
Since: Commons Collections 3.1
If there are any elements already in the list being decorated, they are validated.
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: IllegalArgumentException if the map is null
Returns: true if a value predicate is in use
Since: Commons Collections 3.1
Parameters: key the key to validate value the value to validate
Throws: IllegalArgumentException if invalid