public class PredicatedSet extends PredicatedCollection implements java.util.Set
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.
Modifier and Type | Field and Description |
---|---|
private static long |
serialVersionUID
Serialization version
|
predicate
collection
Modifier | Constructor and Description |
---|---|
protected |
PredicatedSet(java.util.Set set,
Predicate predicate)
Constructor that wraps (not copies).
|
Modifier and Type | Method and Description |
---|---|
static java.util.Set |
decorate(java.util.Set set,
Predicate predicate)
Factory method to create a predicated (validating) set.
|
protected java.util.Set |
getSet()
Gets the set being decorated.
|
add, addAll, decorate, validate
clear, contains, containsAll, equals, getCollection, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
private static final long serialVersionUID
protected PredicatedSet(java.util.Set set, Predicate 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.IllegalArgumentException
- if set or predicate is nulljava.lang.IllegalArgumentException
- if the set contains invalid elementspublic static java.util.Set decorate(java.util.Set set, Predicate 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.IllegalArgumentException
- if set or predicate is nulljava.lang.IllegalArgumentException
- if the set contains invalid elementsprotected java.util.Set getSet()