E
- the type of the elements in this setpublic class PredicatedSet<E> extends PredicatedCollection<E> implements java.util.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>
Modifier and Type | Field and Description |
---|---|
private static long |
serialVersionUID
Serialization version
|
predicate
Modifier | Constructor and Description |
---|---|
protected |
PredicatedSet(java.util.Set<E> set,
Predicate<? super E> predicate)
Constructor that wraps (not copies).
|
Modifier and Type | Method and Description |
---|---|
protected java.util.Set<E> |
decorated()
Gets the set being decorated.
|
boolean |
equals(java.lang.Object object) |
int |
hashCode() |
static <E> PredicatedSet<E> |
predicatedSet(java.util.Set<E> set,
Predicate<? super E> predicate)
Factory method to create a predicated (validating) set.
|
add, addAll, builder, notNullBuilder, predicatedCollection, validate
clear, contains, containsAll, isEmpty, iterator, remove, removeAll, removeIf, retainAll, setCollection, size, toArray, toArray, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
private static final long serialVersionUID
protected PredicatedSet(java.util.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 nullpredicate
- the predicate to use for validation, must not be nulljava.lang.NullPointerException
- if set or predicate is nulljava.lang.IllegalArgumentException
- if the set contains invalid elementspublic static <E> PredicatedSet<E> predicatedSet(java.util.Set<E> set, Predicate<? super E> predicate)
If there are any elements already in the set being decorated, they are validated.
E
- the element typeset
- the set to decorate, must not be nullpredicate
- the predicate to use for validation, must not be nulljava.lang.NullPointerException
- if set or predicate is nulljava.lang.IllegalArgumentException
- if the set contains invalid elementsprotected java.util.Set<E> decorated()
decorated
in class AbstractCollectionDecorator<E>
public boolean equals(java.lang.Object object)