Class PredicatedSortedBag<E>
java.lang.Object
org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>
org.apache.commons.collections4.collection.PredicatedCollection<E>
org.apache.commons.collections4.bag.PredicatedBag<E>
org.apache.commons.collections4.bag.PredicatedSortedBag<E>
- Type Parameters:
- E- the type of elements in this bag
- All Implemented Interfaces:
- Serializable,- Iterable<E>,- Collection<E>,- Bag<E>,- SortedBag<E>
Decorates another 
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.
- 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 SummaryConstructorsModifierConstructorDescriptionprotectedPredicatedSortedBag(SortedBag<E> bag, Predicate<? super E> predicate) Constructor that wraps (not copies).
- 
Method SummaryModifier and TypeMethodDescriptionComparator<? super E> Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.Gets the decorated sorted bag.first()Returns the first (lowest) member.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.Methods inherited from class org.apache.commons.collections4.bag.PredicatedBagadd, equals, getCount, hashCode, predicatedBag, remove, uniqueSetMethods 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 org.apache.commons.collections4.Bagadd, add, containsAll, getCount, iterator, remove, remove, removeAll, retainAll, size, uniqueSetMethods inherited from interface java.util.CollectionaddAll, clear, contains, equals, hashCode, isEmpty, parallelStream, removeIf, spliterator, stream, toArray, toArray
- 
Constructor Details- 
PredicatedSortedBagConstructor that wraps (not copies).If there are any elements already in the bag being decorated, they are validated. - Parameters:
- bag- the bag to decorate, must not be null
- predicate- the predicate to use for validation, must not be null
- Throws:
- NullPointerException- if bag or predicate is null
- IllegalArgumentException- if the bag contains invalid elements
 
 
- 
- 
Method Details- 
predicatedSortedBagpublic static <E> PredicatedSortedBag<E> predicatedSortedBag(SortedBag<E> bag, Predicate<? super E> predicate) Factory method to create a predicated (validating) bag.If there are any elements already in the bag being decorated, they are validated. - Type Parameters:
- E- the type of the elements in the bag
- Parameters:
- bag- the bag to decorate, must not be null
- predicate- the predicate to use for validation, must not be null
- Returns:
- a new predicated SortedBag
- Throws:
- NullPointerException- if bag or predicate is null
- IllegalArgumentException- if the bag contains invalid elements
- Since:
- 4.0
 
- 
comparatorDescription copied from interface:SortedBagReturns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.- Specified by:
- comparatorin interface- SortedBag<E>
- Returns:
- the comparator in use, or null if natural ordering
 
- 
decorated
- 
first
- 
last
 
-