E - the type of elements in this bagpublic class PredicatedSortedBag<E> extends PredicatedBag<E> implements SortedBag<E>
SortedBag to validate that additions
match a specified predicate.
This bag exists to provide validation for the decorated bag.
It is normally created to decorate an empty bag.
If an object cannot be added to the bag, an IllegalArgumentException is thrown.
One usage would be to ensure that no null entries are added to the bag.
SortedBag bag = PredicatedSortedBag.predicatedSortedBag(new TreeBag(), NotNullPredicate.INSTANCE);
This class is Serializable from Commons Collections 3.1.
PredicatedCollection.Builder<E>predicate| Modifier | Constructor and Description |
|---|---|
protected |
PredicatedSortedBag(SortedBag<E> bag,
Predicate<? super E> predicate)
Constructor that wraps (not copies).
|
| Modifier and Type | Method and Description |
|---|---|
Comparator<? super E> |
comparator()
Returns the comparator associated with this sorted set, or null
if it uses its elements' natural ordering.
|
protected SortedBag<E> |
decorated()
Gets the decorated sorted bag.
|
E |
first()
Returns the first (lowest) member.
|
E |
last()
Returns the last (highest) member.
|
static <E> PredicatedSortedBag<E> |
predicatedSortedBag(SortedBag<E> bag,
Predicate<? super E> predicate)
Factory method to create a predicated (validating) bag.
|
add, equals, getCount, hashCode, predicatedBag, remove, uniqueSetadd, addAll, builder, notNullBuilder, predicatedCollection, validateclear, contains, containsAll, isEmpty, iterator, remove, removeAll, removeIf, retainAll, setCollection, size, toArray, toArray, toStringclone, finalize, getClass, notify, notifyAll, wait, wait, waitadd, add, containsAll, getCount, iterator, remove, remove, removeAll, retainAll, size, uniqueSetaddAll, clear, contains, equals, hashCode, isEmpty, parallelStream, removeIf, spliterator, stream, toArray, toArrayprotected PredicatedSortedBag(SortedBag<E> bag, Predicate<? super E> predicate)
If there are any elements already in the bag being decorated, they are validated.
bag - the bag to decorate, must not be nullpredicate - the predicate to use for validation, must not be nullNullPointerException - if bag or predicate is nullIllegalArgumentException - if the bag contains invalid elementspublic static <E> PredicatedSortedBag<E> predicatedSortedBag(SortedBag<E> bag, Predicate<? super E> predicate)
If there are any elements already in the bag being decorated, they are validated.
E - the type of the elements in the bagbag - the bag to decorate, must not be nullpredicate - the predicate to use for validation, must not be nullNullPointerException - if bag or predicate is nullIllegalArgumentException - if the bag contains invalid elementsprotected SortedBag<E> decorated()
decorated in class PredicatedBag<E>public E first()
SortedBagpublic E last()
SortedBagpublic Comparator<? super E> comparator()
SortedBagcomparator in interface SortedBag<E>Copyright © 2001–2019 The Apache Software Foundation. All rights reserved.