Class PredicatedBag<E>
- Type Parameters:
E- the type of elements in this bag
- All Implemented Interfaces:
Serializable,Iterable<E>,Collection<E>,Bag<E>
- Direct Known Subclasses:
PredicatedSortedBag
Bag 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.
Bag bag = PredicatedBag.predicatedBag(new HashBag(), NotNullPredicate.INSTANCE);
This class is Serializable from Commons Collections 3.1.
- Since:
- 3.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.commons.collections4.collection.PredicatedCollection
PredicatedCollection.Builder<E> -
Field Summary
Fields inherited from class org.apache.commons.collections4.collection.PredicatedCollection
predicate -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedPredicatedBag(Bag<E> bag, Predicate<? super E> predicate) Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionbooleanAddsnCopiescopies of the specified object to the Bag.Gets the decorated bag.booleanintGets the number of occurrences (cardinality) of the given object currently in the bag.inthashCode()static <E> PredicatedBag<E> predicatedBag(Bag<E> bag, Predicate<? super E> predicate) Factory method to create a predicated (validating) bag.booleanRemovesnCopiescopies of the specified object from the Bag.Returns aSetof unique elements in the Bag.Methods inherited from class org.apache.commons.collections4.collection.PredicatedCollection
add, addAll, builder, notNullBuilder, predicatedCollection, validateMethods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator
clear, contains, containsAll, isEmpty, iterator, remove, removeAll, removeIf, retainAll, setCollection, size, toArray, toArray, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.collections4.Bag
add, containsAll, iterator, remove, removeAll, retainAll, sizeMethods inherited from interface java.util.Collection
addAll, clear, contains, isEmpty, parallelStream, removeIf, spliterator, stream, toArray, toArray
-
Constructor Details
-
PredicatedBag
Constructor 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 nullpredicate- the predicate to use for validation, must not be null- Throws:
NullPointerException- if bag or predicate is nullIllegalArgumentException- if the bag contains invalid elements
-
-
Method Details
-
predicatedBag
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 nullpredicate- the predicate to use for validation, must not be null- Returns:
- a new predicated Bag
- Throws:
NullPointerException- if bag or predicate is nullIllegalArgumentException- if the bag contains invalid elements- Since:
- 4.0
-
add
Description copied from interface:BagAddsnCopiescopies of the specified object to the Bag.If the object is already in the
Bag.uniqueSet()then increment its count as reported byBag.getCount(Object). Otherwise add it to theBag.uniqueSet()and report its count asnCopies. -
decorated
-
equals
-
getCount
Description copied from interface:BagGets the number of occurrences (cardinality) of the given object currently in the bag. If the object does not exist in the bag, return 0. -
hashCode
-
remove
Description copied from interface:BagRemovesnCopiescopies of the specified object from the Bag.If the number of copies to remove is greater than the actual number of copies in the Bag, no error is thrown.
-
uniqueSet
-