public class PredicatedSet<E> extends PredicatedCollection<E> implements Set <E>
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.
PredicatedCollection.Builder <E> predicate| Modifier | Constructor and Description |
|---|---|
protected |
PredicatedSet(Set
Constructor that wraps (not copies).
|
| Modifier and Type | Method and Description |
|---|---|
protected Set |
decorated()
Gets the set being decorated.
|
boolean |
equals(Object
|
int |
hashCode()
|
static <E> PredicatedSet |
predicatedSet(Set
Factory method to create a predicated (validating) set.
|
add, addAll, builder, notNullBuilder, predicatedCollection, validateclear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, setCollection, size, toArray, toArray, toStringclone, finalize, getClass, notify, notifyAll, wait, wait, waitadd, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArrayparallelStream, removeIf, streamprotected PredicatedSet(Set<E> set, Predicate <? super E> predicate)
If there are any elements already in the set being decorated, they are validated.
set - the set to decorate, must not be null
predicate - the predicate to use for validation, must not be null
NullPointerException - if set or predicate is null
IllegalArgumentException - if the set contains invalid elements
public static <E> PredicatedSet<E> predicatedSet(Set <E> set, Predicate <? super E> predicate)
If there are any elements already in the set being decorated, they are validated.
E - the element type
set - the set to decorate, must not be null
predicate - the predicate to use for validation, must not be null
NullPointerException - if set or predicate is null
IllegalArgumentException - if the set contains invalid elements
protected Set<E> decorated()
decorated in class
AbstractCollectionDecorator<E>
public boolean equals(Objectobject)
public int hashCode()