org.apache.commons.collections4.set

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>

Type Parameters:

E - the type of the elements in this set

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 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.

Since:

3.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.collections4.collection.PredicatedCollection

PredicatedCollection.Builder<E>

Method Summary

Modifier and Type	Method and Description
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

Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator

clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

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 null

predicate - the predicate to use for validation, must not be null

Returns:

a decorated set

Throws:

java.lang.NullPointerException - if set or predicate is null

java.lang.IllegalArgumentException - if the set contains invalid elements

Since:

4.0

equals

public boolean equals(java.lang.Object object)

Specified by:

equals in interface java.util.Collection<E>

Specified by:

equals in interface java.util.Set<E>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<E>

Specified by:

hashCode in interface java.util.Set<E>

Overrides:

hashCode in class java.lang.Object