org.apache.commons.collections.collection
Class TransformedCollection
java.lang.Object
|
+--org.apache.commons.collections.collection.AbstractCollectionDecorator
|
+--org.apache.commons.collections.collection.TransformedCollection
- All Implemented Interfaces:
- Collection
- Direct Known Subclasses:
- TransformedBag, TransformedBuffer, TransformedList, TransformedSet
- public class TransformedCollection
- extends AbstractCollectionDecorator
Decorates another Collection
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:18 $
- 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 |
transformer
protected final Transformer transformer
- The transformer to use
TransformedCollection
protected TransformedCollection(Collection coll,
Transformer transformer)
- Constructor that wraps (not copies).
If there are any elements already in the collection being decorated, they
are NOT transformed.
- Parameters:
coll
- the collection to decorate, must not be nulltransformer
- the transformer to use for conversion, must not be null- Throws:
IllegalArgumentException
- if collection or transformer is null
decorate
public static Collection decorate(Collection coll,
Transformer transformer)
- Factory method to create a transforming collection.
If there are any elements already in the collection being decorated, they
are NOT transformed.
- Parameters:
coll
- the collection to decorate, must not be nulltransformer
- the transformer to use for conversion, must not be null- Throws:
IllegalArgumentException
- if collection or transformer is null
transform
protected Object transform(Object object)
- Transforms an object.
The transformer itself may throw an exception if necessary.
- Parameters:
object
- the object to transform- Returns:
- a transformed object
transform
protected Collection transform(Collection coll)
- Transforms a collection.
The transformer itself may throw an exception if necessary.
- Parameters:
coll
- the collection to transform- Returns:
- a transformed object
add
public boolean add(Object object)
- Overrides:
add
in class AbstractCollectionDecorator
addAll
public boolean addAll(Collection coll)
- Overrides:
addAll
in class AbstractCollectionDecorator
Copyright © 2001-2004 Apache Software Foundation. All Rights Reserved.