⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.apache.commons.collections.map

Class PredicatedMap

java.lang.Object
|
+--org.apache.commons.collections.map.AbstractMapDecorator
   |
   +--org.apache.commons.collections.map.PredicatedMap

Known Direct 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
Authors:
Stephen Colebourne
Paul Jack

Field Summary

Predicate

keyPredicate

The key predicate to use

Predicate

valuePredicate

The value predicate to use

Constructor Summary

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)

void

validate(Object key, Object value)

Field Details

keyPredicate

protected final Predicate keyPredicate

The key predicate to use


valuePredicate

protected final Predicate valuePredicate

The value predicate to use

Constructor Details

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:
- if the map is null

Method Details

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:
- if the map is null

entrySet

public Set entrySet()


put

public Object put(Object key, Object value)

Parameters:
key
value

putAll

public void putAll(Map mapToCopy)

Parameters:
mapToCopy

validate

protected void validate(Object key, Object value)

Parameters:
key
value