⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.apache.commons.collections.collection

Class TransformedCollection

java.lang.Object
|
+--org.apache.commons.collections.collection.AbstractCollectionDecorator
   |
   +--org.apache.commons.collections.collection.TransformedCollection

Known Direct 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
Author:
Stephen Colebourne

Field Summary

Transformer

transformer

The transformer to use

Constructor Summary

TransformedCollection(Collection coll, Transformer transformer)

Constructor that wraps (not copies).

Method Summary

boolean

add(Object object)

boolean

addAll(Collection coll)

static Collection

decorate(Collection coll, Transformer transformer)

Factory method to create a transforming collection.

Object

transform(Object object)

Transforms an object.

Collection

transform(Collection coll)

Transforms a collection.

Field Details

transformer

protected final Transformer transformer

The transformer to use

Constructor Details

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 null
transformer - the transformer to use for conversion, must not be null
Throws:
- if collection or transformer is null

Method Details

add

public boolean add(Object object)

Parameters:
object

addAll

public boolean addAll(Collection coll)

Parameters:
coll

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 null
transformer - the transformer to use for conversion, must not be null
Throws:
- if collection or transformer is null

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

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