|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.collections4.map.AbstractIterableMap<K,V>
org.apache.commons.collections4.map.AbstractMapDecorator<K,V>
org.apache.commons.collections4.map.PredicatedMap<K,V>
public class PredicatedMap<K,V>
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.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface java.util.Map |
---|
Map.Entry<K,V> |
Field Summary | |
---|---|
protected Predicate<? super K> |
keyPredicate
The key predicate to use |
protected Predicate<? super V> |
valuePredicate
The value predicate to use |
Constructor Summary | |
---|---|
protected |
PredicatedMap(Map<K,V> map,
Predicate<? super K> keyPredicate,
Predicate<? super V> valuePredicate)
Constructor that wraps (not copies). |
Method Summary | ||
---|---|---|
protected V |
checkSetValue(V value)
Override to validate an object set into the map via setValue . |
|
Set<Map.Entry<K,V>> |
entrySet()
|
|
protected boolean |
isSetValueChecking()
Override to only return true when there is a value transformer. |
|
static
|
predicatedMap(Map<K,V> map,
Predicate<? super K> keyPredicate,
Predicate<? super V> valuePredicate)
Factory method to create a predicated (validating) map. |
|
V |
put(K key,
V value)
Note that the return type is Object, rather than V as in the Map interface. |
|
void |
putAll(Map<? extends K,? extends V> mapToCopy)
|
|
protected void |
validate(K key,
V value)
Validates a key value pair. |
Methods inherited from class org.apache.commons.collections4.map.AbstractMapDecorator |
---|
clear, containsKey, containsValue, decorated, 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 |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected final Predicate<? super K> keyPredicate
protected final Predicate<? super V> valuePredicate
Constructor Detail |
---|
protected PredicatedMap(Map<K,V> map, Predicate<? super K> keyPredicate, Predicate<? super V> valuePredicate)
map
- the map to decorate, must not be nullkeyPredicate
- the predicate to validate the keys, null means no checkvaluePredicate
- the predicate to validate to values, null means no check
IllegalArgumentException
- if the map is nullMethod Detail |
---|
public static <K,V> PredicatedMap<K,V> predicatedMap(Map<K,V> map, Predicate<? super K> keyPredicate, Predicate<? super V> valuePredicate)
If there are any elements already in the list being decorated, they are validated.
K
- the key typeV
- the value typemap
- the map to decorate, must not be nullkeyPredicate
- the predicate to validate the keys, null means no checkvaluePredicate
- the predicate to validate to values, null means no check
IllegalArgumentException
- if the map is nullprotected void validate(K key, V value)
key
- the key to validatevalue
- the value to validate
IllegalArgumentException
- if invalidprotected V checkSetValue(V value)
setValue
.
value
- the value to validate
IllegalArgumentException
- if invalidprotected boolean isSetValueChecking()
public V put(K key, V value)
Put
put
in interface Map<K,V>
put
in interface Put<K,V>
put
in class AbstractMapDecorator<K,V>
Map.put(Object, Object)
public void putAll(Map<? extends K,? extends V> mapToCopy)
putAll
in interface Map<K,V>
putAll
in interface Put<K,V>
putAll
in class AbstractMapDecorator<K,V>
Map.putAll(Map)
public Set<Map.Entry<K,V>> entrySet()
entrySet
in interface Map<K,V>
entrySet
in interface Get<K,V>
entrySet
in class AbstractMapDecorator<K,V>
Map.entrySet()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |