org.apache.commons.collections.bag

Class TransformedBag

public class TransformedBag extends TransformedCollection implements Bag

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.

Since: Commons Collections 3.0

Version: $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $

Author: Stephen Colebourne

Constructor Summary
protected TransformedBag(Bag bag, Transformer transformer)
Constructor that wraps (not copies).
Method Summary
booleanadd(Object object, int nCopies)
static Bagdecorate(Bag bag, Transformer transformer)
Factory method to create a transforming bag.
protected BaggetBag()
Gets the decorated bag.
intgetCount(Object object)
booleanremove(Object object, int nCopies)
SetuniqueSet()

Constructor Detail

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.

Parameters: bag the bag to decorate, must not be null transformer the transformer to use for conversion, must not be null

Throws: IllegalArgumentException if bag or transformer is null

Method Detail

add

public boolean add(Object object, int nCopies)

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.

Parameters: bag the bag to decorate, must not be null transformer the transformer to use for conversion, must not be null

Returns: a new transformed Bag

Throws: IllegalArgumentException if bag or transformer is null

getBag

protected Bag getBag()
Gets the decorated bag.

Returns: the decorated bag

getCount

public int getCount(Object object)

remove

public boolean remove(Object object, int nCopies)

uniqueSet

public Set uniqueSet()
Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.