org.apache.commons.collections.map
Class PredicatedMap
- Map, Serializable
public class PredicatedMap
extends org.apache.commons.collections.map.AbstractInputCheckedMapDecorator
implements Serializable
Decorates another
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);
This class is Serializable from Commons Collections 3.1.
$Revision: 1.14 $ $Date: 2004/06/07 22:14:42 $- Stephen Colebourne
- Paul Jack
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.
|
clear , containsKey , containsValue , entrySet , equals , get , getMap , hashCode , isEmpty , keySet , put , putAll , remove , size , toString , values |
keyPredicate
protected final Predicate keyPredicate
The key predicate to use
valuePredicate
protected final Predicate valuePredicate
The value predicate to use
PredicatedMap
protected PredicatedMap(Map map,
Predicate keyPredicate,
Predicate valuePredicate)
Constructor that wraps (not copies).
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 check
checkSetValue
protected Object checkSetValue(Object value)
Override to validate an object set into the map via setValue
.
- checkSetValue in interface org.apache.commons.collections.map.AbstractInputCheckedMapDecorator
value
- the value to validate
decorate
public static Map decorate(Map map,
Predicate keyPredicate,
Predicate valuePredicate)
Factory method to create a predicated (validating) map.
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 check
isSetValueChecking
protected boolean isSetValueChecking()
Override to only return true when there is a value transformer.
- isSetValueChecking in interface org.apache.commons.collections.map.AbstractInputCheckedMapDecorator
- true if a value predicate is in use
validate
protected void validate(Object key,
Object value)
Validates a key value pair.
key
- the key to validatevalue
- the value to validate
Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.