public class

PredicatedSet

extends PredicatedCollection
implements Set<E>
java.lang.Object
   ↳ org.apache.commons.collections.collection.AbstractCollectionDecorator
     ↳ org.apache.commons.collections.collection.AbstractSerializableCollectionDecorator
       ↳ org.apache.commons.collections.collection.PredicatedCollection
         ↳ org.apache.commons.collections.set.PredicatedSet
Known Direct Subclasses

Class Overview

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.

Summary

[Expand]
Inherited Fields
From class org.apache.commons.collections.collection.PredicatedCollection
From class org.apache.commons.collections.collection.AbstractCollectionDecorator
Protected Constructors
PredicatedSet(Set set, Predicate predicate)
Constructor that wraps (not copies).
Public Methods
static Set decorate(Set set, Predicate predicate)
Factory method to create a predicated (validating) set.
Protected Methods
Set getSet()
Gets the set being decorated.
[Expand]
Inherited Methods
From class org.apache.commons.collections.collection.PredicatedCollection
From class org.apache.commons.collections.collection.AbstractCollectionDecorator
From class java.lang.Object
From interface java.lang.Iterable
From interface java.util.Collection
From interface java.util.Set

Protected Constructors

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

Public Methods

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

Protected Methods

protected Set getSet ()

Gets the set being decorated.

Returns
  • the decorated set