Class PredicatedSet<E>
- java.lang.Object
-
- org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>
-
- org.apache.commons.collections4.collection.PredicatedCollection<E>
-
- org.apache.commons.collections4.set.PredicatedSet<E>
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Iterable<E>
,java.util.Collection<E>
,java.util.Set<E>
- Direct Known Subclasses:
PredicatedSortedSet
public class PredicatedSet<E> extends PredicatedCollection<E> implements java.util.Set<E>
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:
- 3.0
- Version:
- $Id: PredicatedSet.java 1686855 2015-06-22 13:00:27Z tn $
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.commons.collections4.collection.PredicatedCollection
PredicatedCollection.Builder<E>
-
-
Field Summary
-
Fields inherited from class org.apache.commons.collections4.collection.PredicatedCollection
predicate
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
PredicatedSet(java.util.Set<E> set, Predicate<? super E> predicate)
Constructor that wraps (not copies).
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.util.Set<E>
decorated()
Gets the set being decorated.boolean
equals(java.lang.Object object)
int
hashCode()
static <E> PredicatedSet<E>
predicatedSet(java.util.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, builder, notNullBuilder, predicatedCollection, validate
-
Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator
clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, setCollection, size, toArray, toArray, toString
-
-
-
-
Constructor Detail
-
PredicatedSet
protected PredicatedSet(java.util.Set<E> set, Predicate<? super E> 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.NullPointerException
- if set or predicate is nulljava.lang.IllegalArgumentException
- if the set contains invalid elements
-
-
Method Detail
-
predicatedSet
public static <E> PredicatedSet<E> predicatedSet(java.util.Set<E> set, Predicate<? super E> predicate)
Factory method to create a predicated (validating) set.If there are any elements already in the set being decorated, they are validated.
- Type Parameters:
E
- the element type- Parameters:
set
- the set to decorate, must not be nullpredicate
- the predicate to use for validation, must not be null- Returns:
- a decorated set
- Throws:
java.lang.NullPointerException
- if set or predicate is nulljava.lang.IllegalArgumentException
- if the set contains invalid elements- Since:
- 4.0
-
decorated
protected java.util.Set<E> decorated()
Gets the set being decorated.- Overrides:
decorated
in classAbstractCollectionDecorator<E>
- Returns:
- the decorated set
-
equals
public boolean equals(java.lang.Object object)
-
-