Package org.apache.commons.collections.map

Class PredicatedSortedMap

  • All Implemented Interfaces:
    java.io.Serializable, java.util.Map, java.util.SortedMap
    public class PredicatedSortedMap
extends PredicatedMap
implements java.util.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
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Comparator comparator()  
      static java.util.SortedMap decorate​(java.util.SortedMap map, Predicate keyPredicate, Predicate valuePredicate)
      Factory method to create a predicated (validating) sorted map.
      java.util.Set entrySet()  
      java.lang.Object firstKey()  
      java.util.SortedMap headMap​(java.lang.Object toKey)  
      java.lang.Object lastKey()  
      java.util.SortedMap subMap​(java.lang.Object fromKey, java.lang.Object toKey)  
      java.util.SortedMap tailMap​(java.lang.Object fromKey)  

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.util.Map

        clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size

      • Methods inherited from interface java.util.SortedMap

        entrySet, keySet, values

    • Method Detail

      • decorate

        public static java.util.SortedMap decorate​(java.util.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 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

      • firstKey

        public java.lang.Object firstKey()
        Specified by:
        firstKey in interface java.util.SortedMap

      • lastKey

        public java.lang.Object lastKey()
        Specified by:
        lastKey in interface java.util.SortedMap

      • comparator

        public java.util.Comparator comparator()
        Specified by:
        comparator in interface java.util.SortedMap

      • subMap

        public java.util.SortedMap subMap​(java.lang.Object fromKey,
                                  java.lang.Object toKey)
        Specified by:
        subMap in interface java.util.SortedMap

      • headMap

        public java.util.SortedMap headMap​(java.lang.Object toKey)
        Specified by:
        headMap in interface java.util.SortedMap

      • tailMap

        public java.util.SortedMap tailMap​(java.lang.Object fromKey)
        Specified by:
        tailMap in interface java.util.SortedMap

      • entrySet

        public java.util.Set entrySet()
        Specified by:
        entrySet in interface java.util.Map
        Overrides:
        entrySet in class AbstractMapDecorator