org.apache.commons.collections.map

Class PredicatedSortedMap

public class PredicatedSortedMap extends PredicatedMap implements SortedMap

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

Note that PredicatedSortedMap is not synchronized and is not thread-safe. If you wish to use this map from multiple threads concurrently, you must use appropriate synchronization. The simplest approach is to wrap this map using java.util.Collections#synchronizedSortedMap. This class may throw exceptions when accessed by concurrent threads without synchronization.

This class is Serializable from Commons Collections 3.1.

Since: Commons Collections 3.0

Version: $Revision: 348007 $ $Date: 2005-11-21 22:52:57 +0000 (Mon, 21 Nov 2005) $

Author: Stephen Colebourne Paul Jack

Constructor Summary
protected PredicatedSortedMap(SortedMap map, Predicate keyPredicate, Predicate valuePredicate)
Constructor that wraps (not copies).
Method Summary
Comparatorcomparator()
static SortedMapdecorate(SortedMap map, Predicate keyPredicate, Predicate valuePredicate)
Factory method to create a predicated (validating) sorted map.
ObjectfirstKey()
protected SortedMapgetSortedMap()
Gets the map being decorated.
SortedMapheadMap(Object toKey)
ObjectlastKey()
SortedMapsubMap(Object fromKey, Object toKey)
SortedMaptailMap(Object fromKey)

Constructor Detail

PredicatedSortedMap

protected PredicatedSortedMap(SortedMap 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

comparator

public Comparator comparator()

decorate

public static SortedMap decorate(SortedMap map, Predicate keyPredicate, Predicate 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

firstKey

public Object firstKey()

getSortedMap

protected SortedMap getSortedMap()
Gets the map being decorated.

Returns: the decorated map

headMap

public SortedMap headMap(Object toKey)

lastKey

public Object lastKey()

subMap

public SortedMap subMap(Object fromKey, Object toKey)

tailMap

public SortedMap tailMap(Object fromKey)
Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.