org.apache.commons.collections.bag

Class TransformedSortedBag

Implemented Interfaces:
Bag, Collection, Bag, Serializable, SortedBag

public class TransformedSortedBag
extends TransformedBag
implements SortedBag

Decorates another SortedBag 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.

Version:
$Revision: 1.7 $ $Date: 2004/06/03 22:02:12 $
Author:
Stephen Colebourne
Since:
Commons Collections 3.0

Field Summary

Fields inherited from class org.apache.commons.collections.collection.TransformedCollection

transformer

Fields inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator

collection

Constructor Summary

TransformedSortedBag(SortedBag bag, Transformer transformer)
Constructor that wraps (not copies).

Method Summary

Comparator
comparator()
static SortedBag
decorate(SortedBag bag, Transformer transformer)
Factory method to create a transforming sorted bag.
Object
first()
protected SortedBag
getSortedBag()
Gets the decorated bag.
Object
last()

Methods inherited from class org.apache.commons.collections.bag.TransformedBag

add, decorate, getBag, getCount, remove, uniqueSet

Methods inherited from class org.apache.commons.collections.collection.TransformedCollection

add, addAll, decorate, transform, transform

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

Constructor Details

TransformedSortedBag

protected TransformedSortedBag(SortedBag 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

Method Details

comparator

public Comparator comparator()
Specified by:
comparator in interface SortedBag

decorate

public static SortedBag decorate(SortedBag bag,
                                 Transformer transformer)
Factory method to create a transforming sorted 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 SortedBag

first

public Object first()
Specified by:
first in interface SortedBag

getSortedBag

protected SortedBag getSortedBag()
Gets the decorated bag.
Returns:
the decorated bag

last

public Object last()
Specified by:
last in interface SortedBag

Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.