PredicatedSortedMap

Class Overview

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 synchronizedSortedMap(SortedMap). This class may throw exceptions when accessed by concurrent threads without synchronization.

This class is Serializable from Commons Collections 3.1.

Summary

[Expand] Inherited Fields
From class org.apache.commons.collections.map.PredicatedMap protected final Predicate keyPredicate The key predicate to use protected final Predicate valuePredicate The value predicate to use
From class org.apache.commons.collections.map.AbstractMapDecorator protected Map map The map to decorate

[Expand] Inherited Methods
From class org.apache.commons.collections.map.PredicatedMap Object checkSetValue(Object value) Override to validate an object set into the map via setValue. static Map decorate(Map map, Predicate keyPredicate, Predicate valuePredicate) Factory method to create a predicated (validating) map. Set entrySet() boolean isSetValueChecking() Override to only return true when there is a value transformer. Object put(Object key, Object value) void putAll(Map mapToCopy) void validate(Object key, Object value) Validates a key value pair.
From class org.apache.commons.collections.map.AbstractMapDecorator void clear() boolean containsKey(Object key) boolean containsValue(Object value) Set entrySet() boolean equals(Object object) Object get(Object key) Map getMap() Gets the map being decorated. int hashCode() boolean isEmpty() Set keySet() Object put(Object key, Object value) void putAll(Map mapToCopy) Object remove(Object key) int size() String toString() Collection values()
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface java.util.Map abstract void clear() abstract boolean containsKey(Object arg0) abstract boolean containsValue(Object arg0) abstract Set<Entry<K, V>> entrySet() abstract boolean equals(Object arg0) abstract V get(Object arg0) abstract int hashCode() abstract boolean isEmpty() abstract Set<K> keySet() abstract V put(K arg0, V arg1) abstract void putAll(Map<? extends K, ? extends V> arg0) abstract V remove(Object arg0) abstract int size() abstract Collection<V> values()
From interface java.util.SortedMap abstract Comparator<? super K> comparator() abstract Set<Entry<K, V>> entrySet() abstract K firstKey() abstract SortedMap<K, V> headMap(K arg0) abstract Set<K> keySet() abstract K lastKey() abstract SortedMap<K, V> subMap(K arg0, K arg1) abstract SortedMap<K, V> tailMap(K arg0) abstract Collection<V> values()