Class PredicatedSet
- java.lang.Object
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Iterable
,java.util.Collection
,java.util.Set
- Direct Known Subclasses:
PredicatedSortedSet
public class PredicatedSet extends PredicatedCollection implements java.util.Set
Decorates anotherSet
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: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private static long
serialVersionUID
Serialization version-
Fields inherited from class org.apache.commons.collections.collection.PredicatedCollection
predicate
-
Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator
collection
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
PredicatedSet(java.util.Set set, Predicate predicate)
Constructor that wraps (not copies).
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.util.Set
decorate(java.util.Set set, Predicate predicate)
Factory method to create a predicated (validating) set.protected java.util.Set
getSet()
Gets the set being decorated.-
Methods inherited from class org.apache.commons.collections.collection.PredicatedCollection
add, addAll, decorate, validate
-
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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
Serialization version- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PredicatedSet
protected PredicatedSet(java.util.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:
java.lang.IllegalArgumentException
- if set or predicate is nulljava.lang.IllegalArgumentException
- if the set contains invalid elements
-
-
Method Detail
-
decorate
public static java.util.Set decorate(java.util.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:
java.lang.IllegalArgumentException
- if set or predicate is nulljava.lang.IllegalArgumentException
- if the set contains invalid elements
-
getSet
protected java.util.Set getSet()
Gets the set being decorated.- Returns:
- the decorated set
-
-