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

Field Summary
protected  Predicate keyPredicate
          The key predicate to use
protected  Predicate valuePredicate
          The value predicate to use
 
Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator
map
 
Constructor Summary
protected PredicatedMap(Map map, Predicate keyPredicate, Predicate valuePredicate)
          Constructor that wraps (not copies).
 
Method Summary
static Map decorate(Map map, Predicate keyPredicate, Predicate valuePredicate)
          Factory method to create a predicated (validating) map.
 Set entrySet()
           
 Object put(Object key, Object value)
           
 void putAll(Map mapToCopy)
           
protected  void validate(Object key, Object value)
           
 
Methods inherited from class org.apache.commons.collections.map.AbstractMapDecorator
clear, containsKey, containsValue, equals, get, getMap, hashCode, isEmpty, keySet, remove, size, toString, values
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

keyPredicate

protected final Predicate keyPredicate
The key predicate to use


valuePredicate

protected final Predicate valuePredicate
The value predicate to use

Constructor Detail

PredicatedMap

protected PredicatedMap(Map map,
                        Predicate keyPredicate,
                        Predicate valuePredicate)
Constructor that wraps (not copies).

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
Method Detail

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 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

validate

protected void validate(Object key,
                        Object value)

put

public Object put(Object key,
                  Object value)
Specified by:
put in interface Map
Overrides:
put in class AbstractMapDecorator

putAll

public void putAll(Map mapToCopy)
Specified by:
putAll in interface Map
Overrides:
putAll in class AbstractMapDecorator

entrySet

public Set entrySet()
Specified by:
entrySet in interface Map
Overrides:
entrySet in class AbstractMapDecorator


Copyright © 2001-2004 Apache Software Foundation. All Rights Reserved.