Class PredicatedSortedSet<E>
java.lang.Object
org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>
org.apache.commons.collections4.collection.PredicatedCollection<E>
org.apache.commons.collections4.set.PredicatedSet<E>
org.apache.commons.collections4.set.PredicatedSortedSet<E>
- Type Parameters:
- E- the type of the elements in this set
- All Implemented Interfaces:
- Serializable,- Iterable<E>,- Collection<E>,- Set<E>,- SortedSet<E>
- Direct Known Subclasses:
- PredicatedNavigableSet
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.predicatedSortedSet(new TreeSet(),
                                           NotNullPredicate.notNullPredicate());
 
 This class is Serializable from Commons Collections 3.1.
- Since:
- 3.0
- See Also:
- 
Nested Class SummaryNested classes/interfaces inherited from class org.apache.commons.collections4.collection.PredicatedCollectionPredicatedCollection.Builder<E>
- 
Field SummaryFields inherited from class org.apache.commons.collections4.collection.PredicatedCollectionpredicate
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedPredicatedSortedSet(SortedSet<E> set, Predicate<? super E> predicate) Constructor that wraps (not copies).
- 
Method SummaryModifier and TypeMethodDescriptionComparator<? super E> Gets the sorted set being decorated.first()last()static <E> PredicatedSortedSet<E> predicatedSortedSet(SortedSet<E> set, Predicate<? super E> predicate) Factory method to create a predicated (validating) sorted set.Methods inherited from class org.apache.commons.collections4.set.PredicatedSetequals, hashCode, predicatedSetMethods inherited from class org.apache.commons.collections4.collection.PredicatedCollectionadd, addAll, builder, notNullBuilder, predicatedCollection, validateMethods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecoratorclear, contains, containsAll, isEmpty, iterator, remove, removeAll, removeIf, retainAll, setCollection, size, toArray, toArray, toStringMethods inherited from class java.lang.Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.CollectionparallelStream, removeIf, streamMethods inherited from interface java.util.Setadd, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArrayMethods inherited from interface java.util.SortedSetspliterator
- 
Constructor Details- 
PredicatedSortedSetConstructor 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:
- NullPointerException- if set or predicate is null
- IllegalArgumentException- if the set contains invalid elements
 
 
- 
- 
Method Details- 
predicatedSortedSetpublic static <E> PredicatedSortedSet<E> predicatedSortedSet(SortedSet<E> set, Predicate<? super E> predicate) Factory method to create a predicated (validating) sorted set.If there are any elements already in the set being decorated, they are validated. - Type Parameters:
- E- the element type
- Parameters:
- set- the set to decorate, must not be null
- predicate- the predicate to use for validation, must not be null
- Returns:
- a new predicated sorted set.
- Throws:
- NullPointerException- if set or predicate is null
- IllegalArgumentException- if the set contains invalid elements
- Since:
- 4.0
 
- 
comparator- Specified by:
- comparatorin interface- SortedSet<E>
 
- 
decorated
- 
first
- 
headSet
- 
last
- 
subSet
- 
tailSet
 
-