Package org.apache.commons.collections.map

Class PredicatedMap

  • All Implemented Interfaces:
    Serializable, Map
    Direct Known Subclasses:
    PredicatedSortedMap
    @Deprecated(since="2021-04-30")
public class PredicatedMap
extends AbstractMapDecorator
implements Serializable
    Deprecated.
    Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.
    Decorates another Map 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. 

    Map map = PredicatedSet.decorate(new HashMap(), NotNullPredicate.INSTANCE, null);

    Note that PredicatedMap 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.synchronizedMap(Map). 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
    See Also:
    Serialized Form

    • Method Detail

      • decorate

        public static Map decorate​(Map map,
                           Predicate keyPredicate,
                           Predicate valuePredicate)
        Deprecated.
        Factory method to create a predicated (validating) 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
        Throws:
        IllegalArgumentException - if the map is null