⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.apache.commons.collections.set

Class PredicatedSortedSet

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

All Implemented Interfaces:
Collection, Set, SortedSet

public class PredicatedSortedSet
extends PredicatedSet
implements SortedSet

Decorates another SortedSet 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

PredicatedSortedSet(SortedSet set, Predicate predicate)

Constructor that wraps (not copies).

Method Summary

Comparator

comparator()

static SortedSet

decorate(SortedSet set, Predicate predicate)

Factory method to create a predicated (validating) sorted set.

Object

first()

SortedSet

headSet(Object toElement)

Object

last()

SortedSet

subSet(Object fromElement, Object toElement)

SortedSet

tailSet(Object fromElement)

Constructor Details

PredicatedSortedSet

protected PredicatedSortedSet(SortedSet 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

comparator

public Comparator comparator()

decorate

public static SortedSet decorate(SortedSet set, Predicate predicate)

Factory method to create a predicated (validating) sorted 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

first

public Object first()

headSet

public SortedSet headSet(Object toElement)

Parameters:
toElement

last

public Object last()

subSet

public SortedSet subSet(Object fromElement, Object toElement)

Parameters:
fromElement
toElement

tailSet

public SortedSet tailSet(Object fromElement)

Parameters:
fromElement
Generated on February 15, 2004 by GNU Classpath Tools (Gjdoc XmlDoclet 0.6.1).