org.apache.commons.collections.map
Class PredicatedSortedMap
java.lang.Object
|
+--org.apache.commons.collections.map.AbstractMapDecorator
|
+--org.apache.commons.collections.map.PredicatedMap
|
+--org.apache.commons.collections.map.PredicatedSortedMap
- All Implemented Interfaces:
- Map, SortedMap
- public class PredicatedSortedMap
- extends PredicatedMap
- implements SortedMap
Decorates another SortedMap
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
- Version:
- $Revision: 1.3 $ $Date: 2004/01/14 21:43:11 $
- Author:
- Stephen Colebourne, Paul Jack
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 interface java.util.Map |
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values |
PredicatedSortedMap
protected PredicatedSortedMap(SortedMap map,
Predicate keyPredicate,
Predicate valuePredicate)
- Constructor that wraps (not copies).
- Parameters:
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- Throws:
IllegalArgumentException
- if the map is null
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 nullkeyPredicate
- the predicate to validate the keys, null means no checkvaluePredicate
- the predicate to validate to values, null means no check- Throws:
IllegalArgumentException
- if the map is null
getSortedMap
protected SortedMap getSortedMap()
- Gets the map being decorated.
- Returns:
- the decorated map
firstKey
public Object firstKey()
- Specified by:
firstKey
in interface SortedMap
lastKey
public Object lastKey()
- Specified by:
lastKey
in interface SortedMap
comparator
public Comparator comparator()
- Specified by:
comparator
in interface SortedMap
subMap
public SortedMap subMap(Object fromKey,
Object toKey)
- Specified by:
subMap
in interface SortedMap
headMap
public SortedMap headMap(Object toKey)
- Specified by:
headMap
in interface SortedMap
tailMap
public SortedMap tailMap(Object fromKey)
- Specified by:
tailMap
in interface SortedMap
Copyright © 2001-2004 Apache Software Foundation. All Rights Reserved.