org.apache.commons.collections.set

Class PredicatedSet

java.lang.Object
|
+--org.apache.commons.collections.collection.AbstractCollectionDecorator
   |
   +--org.apache.commons.collections.collection.PredicatedCollection
      |
      +--org.apache.commons.collections.set.PredicatedSet

All Implemented Interfaces:
Collection, Set

Known Direct Subclasses:
PredicatedSortedSet

public class PredicatedSet
extends PredicatedCollection
implements Set

Decorates another Set to validate that all additions match a specified predicate.

If an object cannot be added to the set, an IllegalArgumentException is thrown.

Since:

Commons Collections 3.0

Authors:

Stephen Colebourne
Paul Jack

Constructor Summary

PredicatedSet(Set set, Predicate predicate)

Constructor that wraps (not copies).

Method Summary

static Set

decorate(Set set, Predicate predicate)

Factory method to create a predicated (validating) set.

Set

getSet()

Gets the set being decorated.

Constructor Details

PredicatedSet

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:

- if set or predicate is null
- if the set contains invalid elements

`Method Details`

decoratepublic 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:
 - if set or predicate is null
 - if the set contains invalid elements
getSet
protected Set getSet()
 Gets the set being decorated.
Returns:
the decorated set
Generated on
  February 15, 2004
  by GNU Classpath Tools (Gjdoc XmlDoclet 0.6.1).