Class PredicatedSortedMap<K,​V>

  • Type Parameters:
    K - the type of the keys in this map
    V - the type of the values in this map
    All Implemented Interfaces:, java.util.Map<K,​V>, java.util.SortedMap<K,​V>, Get<K,​V>, IterableGet<K,​V>, IterableMap<K,​V>, Put<K,​V>

    public class PredicatedSortedMap<K,​V>
    extends PredicatedMap<K,​V>
    implements java.util.SortedMap<K,​V>
    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 =
         PredicatedSortedMap.predicatedSortedMap(new TreeMap(),

    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.

    See Also:
    Serialized Form
    • Method Detail

      • predicatedSortedMap

        public static <K,​V> PredicatedSortedMap<K,​V> predicatedSortedMap​(java.util.SortedMap<K,​V> map,
                                                                                     Predicate<? super K> keyPredicate,
                                                                                     Predicate<? super V> valuePredicate)
        Factory method to create a predicated (validating) sorted map.

        If there are any elements already in the list being decorated, they are validated.

        Type Parameters:
        K - the key type
        V - the value type
        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
        a new predicated sorted map
        java.lang.NullPointerException - if the map is null
      • firstKey

        public K firstKey()
        Specified by:
        firstKey in interface java.util.SortedMap<K,​V>
      • lastKey

        public K lastKey()
        Specified by:
        lastKey in interface java.util.SortedMap<K,​V>
      • comparator

        public java.util.Comparator<? super K> comparator()
        Specified by:
        comparator in interface java.util.SortedMap<K,​V>
      • subMap

        public java.util.SortedMap<K,​V> subMap​(K fromKey,
                                                     K toKey)
        Specified by:
        subMap in interface java.util.SortedMap<K,​V>
      • headMap

        public java.util.SortedMap<K,​V> headMap​(K toKey)
        Specified by:
        headMap in interface java.util.SortedMap<K,​V>
      • tailMap

        public java.util.SortedMap<K,​V> tailMap​(K fromKey)
        Specified by:
        tailMap in interface java.util.SortedMap<K,​V>
      • entrySet

        public java.util.Set<java.util.Map.Entry<K,​V>> entrySet()
        Specified by:
        entrySet in interface Get<K,​V>
        Specified by:
        entrySet in interface java.util.Map<K,​V>
        entrySet in class AbstractMapDecorator<K,​V>
        a set view of the mappings contained in this map
        See Also: