org.apache.commons.collections.map
Class PredicatedMap<K,V>

java.lang.Object
  org.apache.commons.collections.map.AbstractMapDecorator<K,V>
      org.apache.commons.collections.map.PredicatedMap<K,V>

All Implemented Interfaces:

Serializable, Map<K,V>

Direct Known Subclasses:

PredicatedSortedMap

public class PredicatedMap<K,V>
extends AbstractMapDecorator<K,V>
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.

Since:

Commons Collections 3.0

Version:

$Revision: 1.1.1.1 $ $Date: 2005/05/23 04:36:02 $

Author:

Stephen Colebourne, Matt Hall, John Watkinson, Paul Jack

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

protected Predicate<? super K>	keyPredicate The key predicate to use
protected Predicate<? super V>	valuePredicate The value predicate to use

Fields inherited from class org.apache.commons.collections.map.AbstractMapDecorator

map

Constructor Summary

protected

PredicatedMap(Map<K,V> map, Predicate<? super K> keyPredicate, Predicate<? super V> valuePredicate) Constructor that wraps (not copies).

Method Summary

protected V	checkSetValue(V value) Override to validate an object set into the map via setValue.
static <K,V> Map<K,V>	decorate(Map<K,V> map, Predicate<? super K> keyPredicate, Predicate<? super V> valuePredicate) Factory method to create a predicated (validating) map.
Set<Map.Entry<K,V>>	entrySet()
protected boolean	isSetValueChecking() Override to only return true when there is a value transformer.
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> mapToCopy)
protected void	validate(K key, V value) Validates a key value pair.

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<? super K> keyPredicate

The key predicate to use

valuePredicate

protected final Predicate<? super V> valuePredicate

The value predicate to use

Constructor Detail

PredicatedMap

protected PredicatedMap(Map<K,V> map,
                        Predicate<? super K> keyPredicate,
                        Predicate<? super V> 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 <K,V> Map<K,V> decorate(Map<K,V> map,
                                      Predicate<? super K> keyPredicate,
                                      Predicate<? super V> 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(K key,
                        V value)

Validates a key value pair.

Parameters:

key - the key to validate

value - the value to validate

Throws:

IllegalArgumentException - if invalid

checkSetValue

protected V checkSetValue(V value)

Override to validate an object set into the map via setValue.

Parameters:

value - the value to validate

Throws:

IllegalArgumentException - if invalid

Since:

Commons Collections 3.1

isSetValueChecking

protected boolean isSetValueChecking()

Override to only return true when there is a value transformer.

Returns:

true if a value predicate is in use

Since:

Commons Collections 3.1

put

public V put(K key,
             V value)

Specified by:

put in interface Map<K,V>

Overrides:

put in class AbstractMapDecorator<K,V>

putAll

public void putAll(Map<? extends K,? extends V> mapToCopy)

Specified by:

putAll in interface Map<K,V>

Overrides:

putAll in class AbstractMapDecorator<K,V>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

Overrides:

entrySet in class AbstractMapDecorator<K,V>