Package org.apache.commons.collections.map

Class PredicatedSortedMap

  • All Implemented Interfaces:
    Serializable, Map, 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);

    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(java.util.SortedMap<K, V>). 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: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
    Author:
    Stephen Colebourne, Paul Jack
    See Also:
    Serialized Form

    • 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