org.apache.commons.collections.set
Class PredicatedSet<E>

java.lang.Object
  org.apache.commons.collections.collection.AbstractCollectionDecorator<E>
      org.apache.commons.collections.collection.AbstractSerializableCollectionDecorator<E>
          org.apache.commons.collections.collection.PredicatedCollection<E>
              org.apache.commons.collections.set.PredicatedSet<E>

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, Set<E>

Direct Known Subclasses:

PredicatedSortedSet

public class PredicatedSet<E>
extends PredicatedCollection<E>
implements 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:

Commons Collections 3.0

Version:

$Revision: 1.1.1.1 $ $Date: 2005/05/23 04:36:22 $

Author:

Stephen Colebourne, Matt Hall, John Watkinson, Paul Jack

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.commons.collections.collection.PredicatedCollection

predicate

Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator

collection

Constructor Summary

protected

PredicatedSet(Set<E> set, Predicate<? super E> predicate) Constructor that wraps (not copies).

Method Summary

static <E> Set<E>	decorate(Set<E> set, Predicate<? super E> predicate) Factory method to create a predicated (validating) set.
protected Set<E>	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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

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

Constructor Detail

PredicatedSet

protected PredicatedSet(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 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

Method Detail

decorate

public static <E> Set<E> decorate(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.

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

getSet

protected Set<E> getSet()

Gets the set being decorated.

Returns:

the decorated set