java.lang.Object | ||||
↳ | org.apache.commons.collections.collection.AbstractCollectionDecorator | |||
↳ | org.apache.commons.collections.collection.AbstractSerializableCollectionDecorator | |||
↳ | org.apache.commons.collections.collection.PredicatedCollection | |||
↳ | org.apache.commons.collections.set.PredicatedSet |
Known Direct Subclasses |
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.
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.commons.collections.collection.PredicatedCollection
| |||||||||||
From class
org.apache.commons.collections.collection.AbstractCollectionDecorator
|
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructor that wraps (not copies).
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Factory method to create a predicated (validating) set.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Gets the set being decorated.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.commons.collections.collection.PredicatedCollection
| |||||||||||
From class
org.apache.commons.collections.collection.AbstractCollectionDecorator
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.lang.Iterable
| |||||||||||
From interface
java.util.Collection
| |||||||||||
From interface
java.util.Set
|
Constructor that wraps (not copies).
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 |
IllegalArgumentException | if set or predicate is null |
---|---|
IllegalArgumentException | if the set contains invalid elements |
Factory method to create a predicated (validating) set.
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 |
IllegalArgumentException | if set or predicate is null |
---|---|
IllegalArgumentException | if the set contains invalid elements |