org.apache.commons.collections4.map

Class PredicatedSortedMap<K,V>

java.lang.Object

org.apache.commons.collections4.map.AbstractIterableMap<K,V>

org.apache.commons.collections4.map.AbstractMapDecorator<K,V>

org.apache.commons.collections4.map.PredicatedMap<K,V>

org.apache.commons.collections4.map.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.io.Serializable, 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(),
                                             NotNullPredicate.notNullPredicate(),
                                             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:

3.0

See Also:

Serialized Form

Nested Class Summary

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

java.util.Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
java.util.Comparator<? super K>	comparator()
java.util.Set<java.util.Map.Entry<K,V>>	entrySet()
K	firstKey()
java.util.SortedMap<K,V>	headMap(K toKey)
K	lastKey()
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.
java.util.SortedMap<K,V>	subMap(K fromKey, K toKey)
java.util.SortedMap<K,V>	tailMap(K fromKey)

Methods inherited from class org.apache.commons.collections4.map.PredicatedMap

predicatedMap, put, putAll

Methods inherited from class org.apache.commons.collections4.map.AbstractMapDecorator

clear, containsKey, containsValue, equals, get, hashCode, isEmpty, keySet, remove, size, toString, values

Methods inherited from class org.apache.commons.collections4.map.AbstractIterableMap

mapIterator

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.SortedMap

entrySet, keySet, values

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

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

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

Returns:

a new predicated sorted map

Throws:

java.lang.NullPointerException - if the map is null

Since:

4.0

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 java.util.Map<K,V>

Specified by:

entrySet in interface Get<K,V>

Overrides:

entrySet in class AbstractMapDecorator<K,V>

Returns:

a set view of the mappings contained in this map

See Also:

Map.entrySet()