org.apache.commons.collections.set

Class PredicatedSortedSet

Implemented Interfaces:
Collection, Serializable, Set, SortedSet

public class PredicatedSortedSet
extends PredicatedSet
implements SortedSet

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.

Version:
$Revision: 1.6 $ $Date: 2004/06/03 22:02:13 $
Authors:
Stephen Colebourne
Paul Jack
Since:
Commons Collections 3.0

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

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)

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

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

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

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

first

public Object first()

headSet

public SortedSet headSet(Object toElement)

last

public Object last()

subSet

public SortedSet subSet(Object fromElement,
                        Object toElement)

tailSet

public SortedSet tailSet(Object fromElement)

Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.