public class PredicatedSortedSet<E> extends PredicatedSet<E> implements SortedSet<E>
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.
predicate| Modifier | Constructor and Description |
|---|---|
protected |
PredicatedSortedSet(SortedSet<E> set,
Predicate<? super E> predicate)
Constructor that wraps (not copies).
|
| Modifier and Type | Method and Description |
|---|---|
Comparator<? super E> |
comparator() |
protected SortedSet<E> |
decorated()
Gets the sorted set being decorated.
|
E |
first() |
SortedSet<E> |
headSet(E toElement) |
E |
last() |
static <E> PredicatedSortedSet<E> |
predicatedSortedSet(SortedSet<E> set,
Predicate<? super E> predicate)
Factory method to create a predicated (validating) sorted set.
|
SortedSet<E> |
subSet(E fromElement,
E toElement) |
SortedSet<E> |
tailSet(E fromElement) |
predicatedSetadd, addAll, predicatedCollection, validateclear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, setCollection, size, toArray, toArray, toStringprotected PredicatedSortedSet(SortedSet<E> set, Predicate<? super E> predicate)
If there are any elements already in the set being decorated, they are validated.
set - the set to decorate, must not be nullpredicate - the predicate to use for validation, must not be nullIllegalArgumentException - if set or predicate is nullIllegalArgumentException - if the set contains invalid elementspublic static <E> PredicatedSortedSet<E> predicatedSortedSet(SortedSet<E> set, Predicate<? super E> predicate)
If there are any elements already in the set being decorated, they are validated.
E - the element typeset - the set to decorate, must not be nullpredicate - the predicate to use for validation, must not be nullIllegalArgumentException - if set or predicate is nullIllegalArgumentException - if the set contains invalid elementsprotected SortedSet<E> decorated()
decorated in class PredicatedSet<E>public Comparator<? super E> comparator()
comparator in interface SortedSet<E>Copyright © 2001–2013 The Apache Software Foundation. All rights reserved.