org.apache.commons.collections.map
Class PredicatedSortedMap
- Map, Serializable, SortedMap
public class PredicatedSortedMap
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
Collections.synchronizedSortedMap
. This class may throw
exceptions when accessed by concurrent threads without synchronization.
This class is Serializable from Commons Collections 3.1.
$Revision: 348007 $ $Date: 2005-11-21 22:52:57 +0000 (Mon, 21 Nov 2005) $- Stephen Colebourne
- Paul Jack
clear , containsKey , containsValue , entrySet , equals , get , getMap , hashCode , isEmpty , keySet , put , putAll , remove , size , toString , values |
PredicatedSortedMap
protected PredicatedSortedMap(SortedMap map,
Predicate keyPredicate,
Predicate valuePredicate)
Constructor that wraps (not copies).
map
- the map to decorate, must not be nullkeyPredicate
- the predicate to validate the keys, null means no checkvaluePredicate
- the predicate to validate to values, null means no check
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.
map
- the map to decorate, must not be nullkeyPredicate
- the predicate to validate the keys, null means no checkvaluePredicate
- the predicate to validate to values, null means no check
firstKey
public Object firstKey()
getSortedMap
protected SortedMap getSortedMap()
Gets the map being decorated.
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-2009 Apache Software Foundation. All Rights Reserved.