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:

java.util.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

Method Summary

boolean	add(java.lang.Object object)
boolean	addAll(java.util.Collection coll)
static java.util.Collection	decorate(java.util.Collection coll, Transformer transformer) Factory method to create a transforming collection.

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

clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

decorate

public static java.util.Collection decorate(java.util.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:

java.lang.IllegalArgumentException - if collection or transformer is null

add

public boolean add(java.lang.Object object)

Specified by:

add in interface java.util.Collection

Overrides:

add in class AbstractCollectionDecorator

addAll

public boolean addAll(java.util.Collection coll)

Specified by:

addAll in interface java.util.Collection

Overrides:

addAll in class AbstractCollectionDecorator