org.apache.commons.collections.set
Class PredicatedSortedSet

java.lang.Object
  extended byorg.apache.commons.collections.collection.AbstractCollectionDecorator
      extended byorg.apache.commons.collections.collection.AbstractSerializableCollectionDecorator
          extended byorg.apache.commons.collections.collection.PredicatedCollection
              extended byorg.apache.commons.collections.set.PredicatedSet
                  extended byorg.apache.commons.collections.set.PredicatedSortedSet
All 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.

Since:
Commons Collections 3.0
Version:
$Revision: 1.6 $ $Date: 2004/06/03 22:02:13 $
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 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
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 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

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

subSet

public SortedSet subSet(Object fromElement,
                        Object toElement)
Specified by:
subSet in interface SortedSet

headSet

public SortedSet headSet(Object toElement)
Specified by:
headSet in interface SortedSet

tailSet

public SortedSet tailSet(Object fromElement)
Specified by:
tailSet in interface SortedSet

first

public Object first()
Specified by:
first in interface SortedSet

last

public Object last()
Specified by:
last in interface SortedSet

comparator

public Comparator comparator()
Specified by:
comparator in interface SortedSet


Copyright © 2001-2007 The Apache Software Foundation. All Rights Reserved.