org.apache.commons.collections.bag
Class TransformedBag
- Bag, Collection, Serializable
public class TransformedBag
Decorates another
Bag
to transform objects that are added.
The add methods are affected by this class.
Thus objects must be removed or searched for using their transformed form.
For example, if the transformation converts Strings to Integers, you must
use the Integer form to remove objects.
This class is Serializable from Commons Collections 3.1.
$Revision: 1.7 $ $Date: 2004/06/03 22:02:12 $
boolean | add(Object object, int nCopies) - Adds
nCopies copies of the specified object to the Bag.
|
static Bag | decorate(Bag bag, Transformer transformer) - Factory method to create a transforming bag.
|
protected Bag | getBag() - Gets the decorated bag.
|
int | getCount(Object object) - Returns the number of occurrences (cardinality) of the given
object currently in the bag.
|
boolean | remove(Object object, int nCopies) - Removes
nCopies copies of the specified object from the Bag.
|
Set | uniqueSet() - Returns a
Set of unique elements in the Bag.
|
add , addAll , clear , contains , containsAll , equals , getCollection , hashCode , isEmpty , iterator , remove , removeAll , retainAll , size , toArray , toArray , toString |
TransformedBag
protected TransformedBag(Bag bag,
Transformer transformer)
Constructor that wraps (not copies).
If there are any elements already in the bag being decorated, they
are NOT transformed.
bag
- the bag to decorate, must not be nulltransformer
- the transformer to use for conversion, must not be null
add
public boolean add(Object object,
int nCopies)
- add in interface Bag
object
- the object to addnCopies
- the number of copies to add
true
if the object was not already in the uniqueSet
decorate
public static Bag decorate(Bag bag,
Transformer transformer)
Factory method to create a transforming bag.
If there are any elements already in the bag being decorated, they
are NOT transformed.
bag
- the bag to decorate, must not be nulltransformer
- the transformer to use for conversion, must not be null
getBag
protected Bag getBag()
Gets the decorated bag.
getCount
public int getCount(Object object)
Returns the number of occurrences (cardinality) of the given
object currently in the bag. If the object does not exist in the
bag, return 0.
- getCount in interface Bag
object
- the object to search for
- the number of occurrences of the object, zero if not found
remove
public boolean remove(Object object,
int nCopies)
Removes
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
object
- the object to removenCopies
- the number of copies to remove
true
if this call changed the collection
uniqueSet
public Set uniqueSet()
Returns a
Set
of unique elements in the Bag.
Uniqueness constraints are the same as those in
java.util.Set
.
- uniqueSet in interface Bag
- the Set of unique Bag elements
Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.