org.apache.commons.collections.bag
Class TransformedSortedBag
java.lang.Object
|
+--org.apache.commons.collections.collection.AbstractCollectionDecorator
|
+--org.apache.commons.collections.collection.TransformedCollection
|
+--org.apache.commons.collections.bag.TransformedBag
|
+--org.apache.commons.collections.bag.TransformedSortedBag
- All Implemented Interfaces:
- Bag, Collection, 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.
- Since:
- Commons Collections 3.0
- Version:
- $Revision: 1.3 $ $Date: 2004/01/14 21:43:08 $
- Author:
- Stephen Colebourne
Methods inherited from class org.apache.commons.collections.collection.AbstractCollectionDecorator |
clear, contains, containsAll, equals, getCollection, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString |
Methods inherited from interface org.apache.commons.collections.Bag |
add, add, containsAll, getCount, iterator, remove, remove, removeAll, retainAll, size, uniqueSet |
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 nulltransformer
- the transformer to use for conversion, must not be null- Throws:
IllegalArgumentException
- if bag or transformer is null
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 nulltransformer
- the transformer to use for conversion, must not be null- Throws:
IllegalArgumentException
- if bag or transformer is null
getSortedBag
protected SortedBag getSortedBag()
- Gets the decorated bag.
- Returns:
- the decorated bag
first
public Object first()
- Description copied from interface:
SortedBag
- Returns the first (lowest) member.
- Specified by:
first
in interface SortedBag
- Following copied from interface:
org.apache.commons.collections.SortedBag
- Returns:
- the first element in the sorted bag
last
public Object last()
- Description copied from interface:
SortedBag
- Returns the last (highest) member.
- Specified by:
last
in interface SortedBag
- Following copied from interface:
org.apache.commons.collections.SortedBag
- Returns:
- the last element in the sorted bag
comparator
public Comparator comparator()
- Description copied from interface:
SortedBag
- Returns the comparator associated with this sorted set, or null
if it uses its elements' natural ordering.
- Specified by:
comparator
in interface SortedBag
- Following copied from interface:
org.apache.commons.collections.SortedBag
- Returns:
- the comparator in use, or null if natural ordering
Copyright © 2001-2004 Apache Software Foundation. All Rights Reserved.