|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.collections4.collection.AbstractCollectionDecorator<E>
org.apache.commons.collections4.collection.PredicatedCollection<E>
org.apache.commons.collections4.set.PredicatedSet<E>
public class PredicatedSet<E>
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.
Field Summary |
---|
Fields inherited from class org.apache.commons.collections4.collection.PredicatedCollection |
---|
predicate |
Constructor Summary | |
---|---|
protected |
PredicatedSet(Set<E> set,
Predicate<? super E> predicate)
Constructor that wraps (not copies). |
Method Summary | ||
---|---|---|
protected Set<E> |
decorated()
Gets the set being decorated. |
|
static
|
predicatedSet(Set<E> set,
Predicate<? super E> predicate)
Factory method to create a predicated (validating) set. |
Methods inherited from class org.apache.commons.collections4.collection.PredicatedCollection |
---|
add, addAll, predicatedCollection, validate |
Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator |
---|
clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, setCollection, size, toArray, toArray, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Set |
---|
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray |
Constructor Detail |
---|
protected 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 nullpredicate
- the predicate to use for validation, must not be null
IllegalArgumentException
- if set or predicate is null
IllegalArgumentException
- if the set contains invalid elementsMethod Detail |
---|
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 typeset
- the set to decorate, must not be nullpredicate
- the predicate to use for validation, must not be null
IllegalArgumentException
- if set or predicate is null
IllegalArgumentException
- if the set contains invalid elementsprotected Set<E> decorated()
decorated
in class AbstractCollectionDecorator<E>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |