|
||||||||||
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.bag.AbstractBagDecorator<E>
public abstract class AbstractBagDecorator<E>
Decorates another Bag
to provide additional behaviour.
Field Summary |
---|
Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator |
---|
collection |
Constructor Summary | |
---|---|
protected |
AbstractBagDecorator()
Constructor only used in deserialization, do not use otherwise. |
protected |
AbstractBagDecorator(Bag<E> bag)
Constructor that wraps (not copies). |
Method Summary | |
---|---|
boolean |
add(E object,
int count)
Adds nCopies copies of the specified object to the Bag. |
protected Bag<E> |
getBag()
Gets the bag being decorated. |
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<E> |
uniqueSet()
Returns a Set of unique elements in the Bag. |
Methods inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator |
---|
add, addAll, 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 AbstractBagDecorator()
protected AbstractBagDecorator(Bag<E> bag)
bag
- the bag to decorate, must not be null
IllegalArgumentException
- if list is nullMethod Detail |
---|
protected Bag<E> getBag()
public int getCount(E object)
Bag
getCount
in interface Bag<E>
object
- the object to search for
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<E> uniqueSet()
Bag
Set
of unique elements in the Bag.
Uniqueness constraints are the same as those in Set
.
uniqueSet
in interface Bag<E>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |