org.apache.commons.collections.set

Class PredicatedSortedSet

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.

Since: Commons Collections 3.0

Version: $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $

Author: Stephen Colebourne Paul Jack

Constructor Summary
protected PredicatedSortedSet(SortedSet set, Predicate predicate)
Constructor that wraps (not copies).
Method Summary
Comparatorcomparator()
static SortedSetdecorate(SortedSet set, Predicate predicate)
Factory method to create a predicated (validating) sorted set.
Objectfirst()
SortedSetheadSet(Object toElement)
Objectlast()
SortedSetsubSet(Object fromElement, Object toElement)
SortedSettailSet(Object fromElement)

Constructor Detail

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: IllegalArgumentException if set or predicate is null IllegalArgumentException if the set contains invalid elements

Method Detail

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: IllegalArgumentException if set or predicate is null IllegalArgumentException if the set contains invalid elements

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-2008 Apache Software Foundation. All Rights Reserved.