net.sf.collections15.collection
Class TransformedCollection<I,O>

java.lang.Object
  net.sf.collections15.collection.AbstractCollectionDecorator<E>
      net.sf.collections15.collection.AbstractSerializableCollectionDecorator<java.lang.Object>
          net.sf.collections15.collection.TransformedCollection<I,O>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<java.lang.Object>, java.util.Collection<java.lang.Object>

public class TransformedCollection<I,O>
extends AbstractSerializableCollectionDecorator<java.lang.Object>

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.

Since:

Commons Collections 3.0

Version:

$Revision: 1.1 $ $Date: 2005/05/25 21:25:42 $

Author:

Stephen Colebourne

See Also:

Serialized Form

Field Summary

protected Transformer<? super I,? extends O>

transformer The transformer to use

Fields inherited from class net.sf.collections15.collection.AbstractCollectionDecorator

collection

Constructor Summary

protected

TransformedCollection(java.util.Collection<? extends O> coll, Transformer<? super I,? extends O> transformer) Constructor that wraps (not copies).

Method Summary

boolean	add(java.lang.Object input) First transform the given input then add the result to the collection
boolean	addAll(java.util.Collection<? extends java.lang.Object> input) First transform all the elements of the input collection, then add the resulting collection to the collection.
boolean	addAllNoTransform(java.util.Collection<? extends O> coll) Add the given collection without first transforming it.
boolean	addNoTransform(O object) Add the given object to the collection without first transforming it.
static <E,S> java.util.Collection<S>	decorate(java.util.Collection<? extends S> coll, Transformer<? super E,? extends S> transformer) Factory method to create a transforming collection.
protected java.util.Collection<O>	transform(java.util.Collection<? extends I> coll) Transforms a collection.
protected O	transform(I object) Transforms an object.

Methods inherited from class net.sf.collections15.collection.AbstractCollectionDecorator

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

transformer

protected final Transformer<? super I,? extends O> transformer

The transformer to use

Constructor Detail

TransformedCollection

protected TransformedCollection(java.util.Collection<? extends O> coll,
                                Transformer<? super I,? extends O> 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:

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

Method Detail

decorate

public static <E,S> java.util.Collection<S> decorate(java.util.Collection<? extends S> coll,
                                                     Transformer<? super E,? extends S> 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:

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

transform

protected O transform(I 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 java.util.Collection<O> transform(java.util.Collection<? extends I> 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(java.lang.Object input)

First transform the given input then add the result to the collection

Specified by:

add in interface java.util.Collection<java.lang.Object>

Overrides:

add in class AbstractCollectionDecorator<java.lang.Object>

Parameters:

input -

Returns:

addAll

public boolean addAll(java.util.Collection<? extends java.lang.Object> input)

First transform all the elements of the input collection, then add the resulting collection to the collection.

Specified by:

addAll in interface java.util.Collection<java.lang.Object>

Overrides:

addAll in class AbstractCollectionDecorator<java.lang.Object>

Parameters:

input -

Returns:

addNoTransform

public boolean addNoTransform(O object)

Add the given object to the collection without first transforming it.

Parameters:

object -

Returns:

Since:

collections15

addAllNoTransform

public boolean addAllNoTransform(java.util.Collection<? extends O> coll)

Add the given collection without first transforming it.

Parameters:

input -

Returns:

Since:

collections15