org.apache.commons.collections.set
Class PredicatedSortedSet<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>
                  org.apache.commons.collections.set.PredicatedSortedSet<E>

All Implemented Interfaces:

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

public class PredicatedSortedSet<E>
extends PredicatedSet<E>
implements SortedSet<E>

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

SortedSet set = PredicatedSortedSet.decorate(new TreeSet(), 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

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

Method Summary

Comparator<? super E>	comparator()
static <E> SortedSet<E>	decorate(SortedSet<E> set, Predicate<? super E> predicate) Factory method to create a predicated (validating) sorted set.
E	first()
SortedSet<E>	headSet(E toElement)
E	last()
SortedSet<E>	subSet(E fromElement, E toElement)
SortedSet<E>	tailSet(E fromElement)

Methods inherited from class org.apache.commons.collections.set.PredicatedSet

decorate, getSet

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

PredicatedSortedSet

protected PredicatedSortedSet(SortedSet<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> SortedSet<E> decorate(SortedSet<E> set,
                                        Predicate<? super E> 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:

IllegalArgumentException - if set or predicate is null

IllegalArgumentException - if the set contains invalid elements

subSet

public SortedSet<E> subSet(E fromElement,
                           E toElement)

Specified by:

subSet in interface SortedSet<E>

headSet

public SortedSet<E> headSet(E toElement)

Specified by:

headSet in interface SortedSet<E>

tailSet

public SortedSet<E> tailSet(E fromElement)

Specified by:

tailSet in interface SortedSet<E>

first

public E first()

Specified by:

first in interface SortedSet<E>

last

public E last()

Specified by:

last in interface SortedSet<E>

comparator

public Comparator<? super E> comparator()

Specified by:

comparator in interface SortedSet<E>