PredicatedSet (The Adobe Experience Manager SDK 2022.11.9850.20221116T162329Z-220900)

java.lang.Object
- org.apache.commons.collections.collection.AbstractCollectionDecorator
- - org.apache.commons.collections.collection.AbstractSerializableCollectionDecorator
  - - org.apache.commons.collections.collection.PredicatedCollection
    - - org.apache.commons.collections.set.PredicatedSet

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable, java.util.Collection, java.util.Set

Direct Known Subclasses:

PredicatedSortedSet
```
@Deprecated(since="2021-04-30")
public class PredicatedSet
extends PredicatedCollection
implements java.util.Set
```
Deprecated.
Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.
Decorates another Set to validate that all additions match a specified predicate.
This set exists to provide validation for the decorated set. It is normally created to decorate an empty set. If an object cannot be added to the set, an IllegalArgumentException is thrown.
One usage would be to ensure that no null entries are added to the set.
```
Set set = PredicatedSet.decorate(new HashSet(), NotNullPredicate.INSTANCE);
```
This class is Serializable from Commons Collections 3.1.
Since:

Commons Collections 3.0

See Also:

Serialized Form

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static java.util.Set`	`decorate(java.util.Set set, Predicate predicate)`	Deprecated. Factory method to create a predicated (validating) set.

Methods inherited from class org.apache.commons.collections.collection.PredicatedCollection
add, addAll, decorate

Methods inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator
clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

- Method Detail
  - decorate
```
public static java.util.Set decorate(java.util.Set set,
                                     Predicate predicate)
```
    Deprecated.
    
    Factory method to create a predicated (validating) set.
    If there are any elements already in the set being decorated, they are validated.
    
    Parameters:
    
    set - the set to decorate, must not be null
    
    predicate - the predicate to use for validation, must not be null
    
    Throws:
    
    java.lang.IllegalArgumentException - if set or predicate is null
    
    java.lang.IllegalArgumentException - if the set contains invalid elements