|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.collections4.collection.AbstractCollectionDecorator<E>
org.apache.commons.collections4.collection.TransformedCollection<E>
org.apache.commons.collections4.bag.TransformedBag<E>
public class TransformedBag<E>
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.
Field Summary |
---|
Fields inherited from class org.apache.commons.collections4.collection.TransformedCollection |
---|
transformer |
Constructor Summary | |
---|---|
protected |
TransformedBag(Bag<E> bag,
Transformer<? super E,? extends E> transformer)
Constructor that wraps (not copies). |
Method Summary | ||
---|---|---|
boolean |
add(E object,
int nCopies)
Adds nCopies copies of the specified object to the Bag. |
|
protected Bag<E> |
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. |
|
static
|
transformedBag(Bag<E> bag,
Transformer<? super E,? extends E> transformer)
Factory method to create a transforming bag that will transform existing contents of the specified bag. |
|
static
|
transformingBag(Bag<E> bag,
Transformer<? super E,? extends E> transformer)
Factory method to create a transforming bag. |
|
Set<E> |
uniqueSet()
Returns a Set of unique elements in the Bag. |
Methods inherited from class org.apache.commons.collections4.collection.TransformedCollection |
---|
add, addAll, transform, transform, transformedCollection, transformingCollection |
Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator |
---|
clear, contains, containsAll, decorated, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, setCollection, 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.collections4.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 TransformedBag(Bag<E> bag, Transformer<? super E,? extends E> 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 null
IllegalArgumentException
- if bag or transformer is nullMethod Detail |
---|
public static <E> Bag<E> transformingBag(Bag<E> bag, Transformer<? super E,? extends E> transformer)
If there are any elements already in the bag being decorated, they
are NOT transformed. Contrast this with transformedBag(Bag, Transformer)
.
E
- the type of the elements in the bagbag
- the bag to decorate, must not be nulltransformer
- the transformer to use for conversion, must not be null
IllegalArgumentException
- if bag or transformer is nullpublic static <E> Bag<E> transformedBag(Bag<E> bag, Transformer<? super E,? extends E> transformer)
If there are any elements already in the bag being decorated, they
will be transformed by this method.
Contrast this with transformingBag(Bag, Transformer)
.
E
- the type of the elements in the bagbag
- the bag to decorate, must not be nulltransformer
- the transformer to use for conversion, must not be null
IllegalArgumentException
- if bag or transformer is nullprotected Bag<E> getBag()
public int getCount(Object object)
Bag
getCount
in interface Bag<E>
object
- the object to search for
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.
remove
in interface Bag<E>
object
- the object to removenCopies
- the number of copies to remove
true
if this call changed the collectionpublic boolean add(E 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
.
add
in interface Bag<E>
object
- the object to addnCopies
- the number of copies to add
true
if the object was not already in the uniqueSet
public 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 |