org.apache.commons.collections.map
Class PredicatedMap
java.lang.Object
|
+--org.apache.commons.collections.map.AbstractMapDecorator
|
+--org.apache.commons.collections.map.PredicatedMap
- All Implemented Interfaces:
- Map
- Direct Known Subclasses:
- PredicatedSortedMap
- public class PredicatedMap
- extends AbstractMapDecorator
Decorates another Map
to validate that additions
match a specified predicate.
If an object cannot be added to the map, an IllegalArgumentException
is thrown.
- Since:
- Commons Collections 3.0
- Version:
- $Revision: 1.6 $ $Date: 2004/01/14 21:43:11 $
- Author:
- Stephen Colebourne, Paul Jack
Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator |
clear, containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, keySet, 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).
- Parameters:
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- Throws:
IllegalArgumentException
- if the map is null
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.
- Parameters:
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- Throws:
IllegalArgumentException
- if the map is null
validate
protected void validate(Object key,
Object value)
put
public Object put(Object key,
Object value)
- Overrides:
put
in class AbstractMapDecorator
putAll
public void putAll(Map mapToCopy)
- Overrides:
putAll
in class AbstractMapDecorator
entrySet
public Set entrySet()
- Overrides:
entrySet
in class AbstractMapDecorator
Copyright © 2001-2004 Apache Software Foundation. All Rights Reserved.