public class PredicatedSet extends PredicatedCollection implements 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.
predicate
collection
Modifier | Constructor and Description |
---|---|
protected |
PredicatedSet(Set set,
Predicate predicate)
Constructor that wraps (not copies).
|
Modifier and Type | Method and Description |
---|---|
static Set |
decorate(Set set,
Predicate predicate)
Factory method to create a predicated (validating) set.
|
protected 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
protected PredicatedSet(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 nullIllegalArgumentException
- if set or predicate is nullIllegalArgumentException
- if the set contains invalid elementspublic static Set decorate(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 nullIllegalArgumentException
- if set or predicate is nullIllegalArgumentException
- if the set contains invalid elementsprotected Set getSet()
Copyright © 2001–2015 The Apache Software Foundation. All rights reserved.