Package org.apache.commons.collections.map

Class PredicatedMap

  • All Implemented Interfaces:
    java.io.Serializable, java.util.Map
    Direct Known Subclasses:
    PredicatedSortedMap
    public class PredicatedMap
extends AbstractInputCheckedMapDecorator
implements java.io.Serializable
    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
    Version:
    $Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
    See Also:
    Serialized Form

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        Serialization version
        See Also:
        Constant Field Values

      • keyPredicate

        protected final Predicate keyPredicate
        The key predicate to use

      • valuePredicate

        protected final Predicate valuePredicate
        The value predicate to use

    • Constructor Detail

      • PredicatedMap

        protected PredicatedMap​(java.util.Map 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:
        java.lang.IllegalArgumentException - if the map is null

    • Method Detail

      • decorate

        public static java.util.Map decorate​(java.util.Map map,
                                     Predicate keyPredicate,
                                     Predicate valuePredicate)
        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:
        java.lang.IllegalArgumentException - if the map is null

      • writeObject

        private void writeObject​(java.io.ObjectOutputStream out)
                  throws java.io.IOException
        Write the map out using a custom routine.
        Parameters:
        out - the output stream
        Throws:
        java.io.IOException
        Since:
        Commons Collections 3.1

      • readObject

        private void readObject​(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException
        Read the map in using a custom routine.
        Parameters:
        in - the input stream
        Throws:
        java.io.IOException
        java.lang.ClassNotFoundException
        Since:
        Commons Collections 3.1

      • validate

        protected void validate​(java.lang.Object key,
                        java.lang.Object value)
        Validates a key value pair.
        Parameters:
        key - the key to validate
        value - the value to validate
        Throws:
        java.lang.IllegalArgumentException - if invalid

      • checkSetValue

        protected java.lang.Object checkSetValue​(java.lang.Object value)
        Override to validate an object set into the map via setValue.
        Specified by:
        checkSetValue in class AbstractInputCheckedMapDecorator
        Parameters:
        value - the value to validate
        Throws:
        java.lang.IllegalArgumentException - if invalid
        Since:
        Commons Collections 3.1

      • isSetValueChecking

        protected boolean isSetValueChecking()
        Override to only return true when there is a value transformer.
        Overrides:
        isSetValueChecking in class AbstractInputCheckedMapDecorator
        Returns:
        true if a value predicate is in use
        Since:
        Commons Collections 3.1

      • put

        public java.lang.Object put​(java.lang.Object key,
                            java.lang.Object value)
        Specified by:
        put in interface java.util.Map
        Overrides:
        put in class AbstractMapDecorator

      • putAll

        public void putAll​(java.util.Map mapToCopy)
        Specified by:
        putAll in interface java.util.Map
        Overrides:
        putAll in class AbstractMapDecorator