Package org.apache.commons.collections.map

Class PredicatedMap

java.lang.Object

org.apache.commons.collections.map.AbstractMapDecorator

org.apache.commons.collections.map.PredicatedMap

All Implemented Interfaces:

Serializable, Map

Direct Known Subclasses:

PredicatedSortedMap

@Deprecated(since="2021-04-30")
public class PredicatedMap
extends AbstractMapDecorator
implements Serializable

Deprecated.

Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.

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

See Also:

• Serialized Form

Nested Class Summary

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

Map.Entry<K,V>

Method Summary

Modifier and Type	Method	Description
static Map	decorate(Map map, Predicate keyPredicate, Predicate valuePredicate)	Deprecated. Factory method to create a predicated (validating) map.
Set	entrySet()	Deprecated.
Object	put(Object key, Object value)	Deprecated.
void	putAll(Map mapToCopy)	Deprecated.

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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Details

decorate

public static Map decorate(Map map,
 Predicate keyPredicate,
 Predicate valuePredicate)

Deprecated.

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:

IllegalArgumentException - if the map is null

put

public Object put(Object key,
 Object value)

Deprecated.

Specified by:

put in interface Map

Overrides:

put in class AbstractMapDecorator

putAll

public void putAll(Map mapToCopy)

Deprecated.

Specified by:

putAll in interface Map

Overrides:

putAll in class AbstractMapDecorator

entrySet

public Set entrySet()

Deprecated.

Specified by:

entrySet in interface Map

Overrides:

entrySet in class AbstractMapDecorator