public class TransformedBag extends TransformedCollection implements Bag
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.
transformer
collection
Modifier | Constructor and Description |
---|---|
protected |
TransformedBag(Bag bag,
Transformer transformer)
Constructor that wraps (not copies).
|
Modifier and Type | Method and Description |
---|---|
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, decorate, transform, transform
clear, contains, containsAll, equals, getCollection, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
protected TransformedBag(Bag bag, Transformer transformer)
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 nullIllegalArgumentException
- if bag or transformer is nullpublic static Bag decorate(Bag bag, Transformer transformer)
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 nullIllegalArgumentException
- if bag or transformer is nullprotected Bag getBag()
public int getCount(Object object)
Bag
public boolean remove(Object object, int nCopies)
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.
public boolean add(Object object, int nCopies)
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
.
Copyright © 2001–2015 The Apache Software Foundation. All rights reserved.