public class

PredicatedSortedSet

extends PredicatedSet
implements SortedSet<E>
java.lang.Object
   ↳ org.apache.commons.collections.collection.AbstractCollectionDecorator
     ↳ org.apache.commons.collections.collection.AbstractSerializableCollectionDecorator
       ↳ org.apache.commons.collections.collection.PredicatedCollection
         ↳ org.apache.commons.collections.set.PredicatedSet
           ↳ org.apache.commons.collections.set.PredicatedSortedSet

Class Overview

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.

Summary

[Expand]
Inherited Fields
From class org.apache.commons.collections.collection.PredicatedCollection
From class org.apache.commons.collections.collection.AbstractCollectionDecorator
Protected Constructors
PredicatedSortedSet(SortedSet set, Predicate predicate)
Constructor that wraps (not copies).
Public Methods
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)
[Expand]
Inherited Methods
From class org.apache.commons.collections.set.PredicatedSet
From class org.apache.commons.collections.collection.PredicatedCollection
From class org.apache.commons.collections.collection.AbstractCollectionDecorator
From class java.lang.Object
From interface java.lang.Iterable
From interface java.util.Collection
From interface java.util.Set
From interface java.util.SortedSet

Protected Constructors

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

Public Methods

public Comparator comparator ()

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

public Object first ()

public SortedSet headSet (Object toElement)

public Object last ()

public SortedSet subSet (Object fromElement, Object toElement)

public SortedSet tailSet (Object fromElement)