|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.collections.collection.AbstractCollectionDecorator<E> org.apache.commons.collections.collection.AbstractSerializableCollectionDecorator<E> org.apache.commons.collections.collection.PredicatedCollection<E> org.apache.commons.collections.bag.PredicatedBag<E>
public class PredicatedBag<E>
Decorates another Bag
to validate that additions
match a specified predicate.
Bag bag = PredicatedBag.decorate(new HashBag(), NotNullPredicate.INSTANCE);This class is Serializable from Commons Collections 3.1.
Field Summary |
---|
Fields inherited from class org.apache.commons.collections.collection.PredicatedCollection |
---|
predicate |
Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator |
---|
collection |
Constructor Summary | |
---|---|
protected |
PredicatedBag(Bag<E> bag,
Predicate<? super E> predicate)
Constructor that wraps (not copies). |
Method Summary | ||
---|---|---|
boolean |
add(E object,
int count)
Adds nCopies copies of the specified object to the Bag. |
|
static
|
decorate(Bag<E> bag,
Predicate<? super E> predicate)
Factory method to create a predicated (validating) bag. |
|
protected Bag<E> |
getBag()
Gets the decorated bag. |
|
int |
getCount(E object)
Returns the number of occurrences (cardinality) of the given object currently in the bag. |
|
boolean |
remove(E object,
int count)
Removes nCopies copies of the specified object from the Bag. |
|
Set |
uniqueSet()
Returns a Set of unique elements in the Bag. |
Methods inherited from class org.apache.commons.collections.collection.PredicatedCollection |
---|
add, addAll, decorate, validate |
Methods inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator |
---|
clear, contains, containsAll, equals, getCollection, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.commons.collections.Bag |
---|
add, containsAll, iterator, remove, removeAll, retainAll, size |
Methods inherited from interface java.util.Collection |
---|
addAll, clear, contains, equals, hashCode, isEmpty, toArray, toArray |
Constructor Detail |
---|
protected PredicatedBag(Bag<E> bag, Predicate<? super E> predicate)
bag
- the bag to decorate, must not be nullpredicate
- the predicate to use for validation, must not be null
IllegalArgumentException
- if bag or predicate is null
IllegalArgumentException
- if the bag contains invalid elementsMethod Detail |
---|
public static <E> Bag<E> decorate(Bag<E> bag, Predicate<? super E> predicate)
bag
- the bag to decorate, must not be nullpredicate
- the predicate to use for validation, must not be null
IllegalArgumentException
- if bag or predicate is null
IllegalArgumentException
- if the bag contains invalid elementsprotected Bag<E> getBag()
public boolean add(E object, int count)
Bag
nCopies
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
.
add
in interface Bag<E>
object
- the object to addcount
- the number of copies to add
true
if the object was not already in the uniqueSet
public boolean remove(E object, int count)
Bag
nCopies
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.
remove
in interface Bag<E>
object
- the object to removecount
- the number of copies to remove
true
if this call changed the collectionpublic Set uniqueSet()
Bag
Set
of unique elements in the Bag.
Uniqueness constraints are the same as those in Set
.
uniqueSet
in interface Bag<E>
public int getCount(E object)
Bag
getCount
in interface Bag<E>
object
- the object to search for
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |