E - the type of elements in this bagpublic class PredicatedBag<E> extends PredicatedCollection<E> implements Bag<E>
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.
PredicatedCollection.Builder<E>predicate| Modifier | Constructor and Description |
|---|---|
protected |
PredicatedBag(Bag<E> bag,
Predicate<? super E> predicate)
Constructor that wraps (not copies).
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
add(E object,
int count)
Adds
nCopies copies of the specified object to the Bag. |
protected Bag<E> |
decorated()
Gets the decorated bag.
|
boolean |
equals(Object object) |
int |
getCount(Object object)
Returns the number of occurrences (cardinality) of the given
object currently in the bag.
|
int |
hashCode() |
static <E> PredicatedBag<E> |
predicatedBag(Bag<E> bag,
Predicate<? super E> predicate)
Factory method to create a predicated (validating) bag.
|
boolean |
remove(Object object,
int count)
Removes
nCopies copies of the specified object from the Bag. |
Set<E> |
uniqueSet()
Returns a
Set of unique elements in the Bag. |
add, 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, containsAll, iterator, remove, removeAll, retainAll, sizeaddAll, clear, contains, isEmpty, parallelStream, removeIf, spliterator, stream, toArray, toArrayprotected PredicatedBag(Bag<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> PredicatedBag<E> predicatedBag(Bag<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 Bag<E> decorated()
decorated in class AbstractCollectionDecorator<E>public boolean equals(Object object)
equals in interface Collection<E>equals in class Objectpublic int hashCode()
hashCode in interface Collection<E>hashCode in class Objectpublic boolean add(E object, int count)
BagnCopies copies of the specified object to the Bag.
If the object is already in the Bag.uniqueSet() then increment its
count as reported by Bag.getCount(Object). Otherwise add it to the
Bag.uniqueSet() and report its count as nCopies.
public boolean remove(Object object, int count)
BagnCopies copies 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.
Copyright © 2001–2019 The Apache Software Foundation. All rights reserved.