public class

TransformedCollection

extends AbstractSerializableCollectionDecorator
java.lang.Object
   ↳ org.apache.commons.collections.collection.AbstractCollectionDecorator
     ↳ org.apache.commons.collections.collection.AbstractSerializableCollectionDecorator
       ↳ org.apache.commons.collections.collection.TransformedCollection
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

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.

This class is Serializable from Commons Collections 3.1.

Summary

Fields
protected final Transformer transformer The transformer to use
[Expand]
Inherited Fields
From class org.apache.commons.collections.collection.AbstractCollectionDecorator
Protected Constructors
TransformedCollection(Collection coll, Transformer transformer)
Constructor that wraps (not copies).
Public Methods
boolean add(Object object)
boolean addAll(Collection coll)
static Collection decorate(Collection coll, Transformer transformer)
Factory method to create a transforming collection.
Protected Methods
Object transform(Object object)
Transforms an object.
Collection transform(Collection coll)
Transforms a collection.
[Expand]
Inherited Methods
From class org.apache.commons.collections.collection.AbstractCollectionDecorator
From class java.lang.Object
From interface java.lang.Iterable
From interface java.util.Collection

Fields

protected final Transformer transformer

The transformer to use

Protected Constructors

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
IllegalArgumentException if collection or transformer is null

Public Methods

public boolean add (Object object)

public boolean addAll (Collection coll)

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
Returns
  • a new transformed collection
Throws
IllegalArgumentException if collection or transformer is null

Protected Methods

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

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