org.apache.commons.collections.map

Class PredicatedSortedMap

Implemented Interfaces:
Map, Serializable, SortedMap

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

This class is Serializable from Commons Collections 3.1.

Version:
$Revision: 1.7 $ $Date: 2004/05/21 21:38:49 $
Authors:
Stephen Colebourne
Paul Jack
Since:
Commons Collections 3.0

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

PredicatedSortedMap(SortedMap map, Predicate keyPredicate, Predicate valuePredicate)
Constructor that wraps (not copies).

Method Summary

Comparator
comparator()
static SortedMap
decorate(SortedMap map, Predicate keyPredicate, Predicate valuePredicate)
Factory method to create a predicated (validating) sorted map.
Object
firstKey()
protected SortedMap
getSortedMap()
Gets the map being decorated.
SortedMap
headMap(Object toKey)
Object
lastKey()
SortedMap
subMap(Object fromKey, Object toKey)
SortedMap
tailMap(Object 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.AbstractInputCheckedMapDecorator

checkSetValue, entrySet, isSetValueChecking

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

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

Constructor Details

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

Method Details

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

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-2006 Apache Software Foundation. All Rights Reserved.