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

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

All Implemented Interfaces:

Serializable, Map<K,V>, SortedMap<K,V>

public class PredicatedSortedMap<K,V>
extends PredicatedMap<K,V>
implements SortedMap<K,V>

Decorates another SortedMap 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.

SortedMap map = PredicatedSortedSet.decorate(new TreeMap(), 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:07 $

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

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

keyPredicate, valuePredicate

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

map

Constructor Summary

protected

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

Method Summary

Comparator<? super K>	comparator()
static <K,V> SortedMap<K,V>	decorate(SortedMap<K,V> map, Predicate<? super K> keyPredicate, Predicate<? super V> valuePredicate) Factory method to create a predicated (validating) sorted map.
Set<Map.Entry<K,V>>	entrySet()
K	firstKey()
protected SortedMap<K,V>	getSortedMap() Gets the map being decorated.
SortedMap<K,V>	headMap(K toKey)
K	lastKey()
SortedMap<K,V>	subMap(K fromKey, K toKey)
SortedMap<K,V>	tailMap(K fromKey)

Methods inherited from class org.apache.commons.collections.map.PredicatedMap

checkSetValue, decorate, isSetValueChecking, put, putAll, validate

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

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

PredicatedSortedMap

protected PredicatedSortedMap(SortedMap<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> SortedMap<K,V> decorate(SortedMap<K,V> map,
                                            Predicate<? super K> keyPredicate,
                                            Predicate<? super V> valuePredicate)

Factory method to create a predicated (validating) sorted 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

getSortedMap

protected SortedMap<K,V> getSortedMap()

Gets the map being decorated.

Returns:

the decorated map

firstKey

public K firstKey()

Specified by:

firstKey in interface SortedMap<K,V>

lastKey

public K lastKey()

Specified by:

lastKey in interface SortedMap<K,V>

comparator

public Comparator<? super K> comparator()

Specified by:

comparator in interface SortedMap<K,V>

subMap

public SortedMap<K,V> subMap(K fromKey,
                             K toKey)

Specified by:

subMap in interface SortedMap<K,V>

headMap

public SortedMap<K,V> headMap(K toKey)

Specified by:

headMap in interface SortedMap<K,V>

tailMap

public SortedMap<K,V> tailMap(K fromKey)

Specified by:

tailMap in interface SortedMap<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>