org.apache.commons.collections.set
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.
Since: Commons Collections 3.0
Version: $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $
Constructor Summary | |
---|---|
protected | PredicatedSet(Set set, Predicate predicate)
Constructor that wraps (not copies).
|
Method Summary | |
---|---|
static Set | decorate(Set set, Predicate predicate)
Factory method to create a predicated (validating) set.
|
protected Set | getSet()
Gets the set being decorated.
|
If there are any elements already in the set being decorated, they are validated.
Parameters: set the set to decorate, must not be null predicate the predicate to use for validation, must not be null
Throws: IllegalArgumentException if set or predicate is null IllegalArgumentException if the set contains invalid elements
If there are any elements already in the set being decorated, they are validated.
Parameters: set the set to decorate, must not be null predicate the predicate to use for validation, must not be null
Throws: IllegalArgumentException if set or predicate is null IllegalArgumentException if the set contains invalid elements
Returns: the decorated set