org.apache.commons.collections.set
Class PredicatedSet
java.lang.Object
|
+--org.apache.commons.collections.collection.AbstractCollectionDecorator
|
+--org.apache.commons.collections.collection.PredicatedCollection
|
+--org.apache.commons.collections.set.PredicatedSet
- All Implemented Interfaces:
- Collection, Set
- Direct Known Subclasses:
- PredicatedSortedSet
- public class PredicatedSet
- extends PredicatedCollection
- implements Set
Decorates another Set
to validate that all additions
match a specified predicate.
If an object cannot be added to the set, an IllegalArgumentException is thrown.
- Since:
- Commons Collections 3.0
- Version:
- $Revision: 1.2 $ $Date: 2004/01/14 21:43:14 $
- Author:
- Stephen Colebourne, Paul Jack
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. |
Methods inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator |
clear, contains, containsAll, equals, getCollection, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString |
Methods inherited from interface java.util.Set |
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray |
PredicatedSet
protected PredicatedSet(Set set,
Predicate predicate)
- Constructor that wraps (not copies).
If there are any elements already in the set being decorated, they
are validated.
- Parameters:
set
- the set to decorate, must not be nullpredicate
- the predicate to use for validation, must not be null- Throws:
IllegalArgumentException
- if set or predicate is nullIllegalArgumentException
- if the set contains invalid elements
decorate
public static Set decorate(Set set,
Predicate predicate)
- Factory method to create a predicated (validating) set.
If there are any elements already in the set being decorated, they
are validated.
- Parameters:
set
- the set to decorate, must not be nullpredicate
- the predicate to use for validation, must not be null- Throws:
IllegalArgumentException
- if set or predicate is nullIllegalArgumentException
- if the set contains invalid elements
getSet
protected Set getSet()
- Gets the set being decorated.
- Returns:
- the decorated set
Copyright © 2001-2004 Apache Software Foundation. All Rights Reserved.