org.apache.commons.collections.set

Class TransformedSet

Implemented Interfaces:
Collection, Serializable, Set
Known Direct Subclasses:
TransformedSortedSet

public class TransformedSet
extends TransformedCollection
implements Set

Decorates another Set 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.

Version:
$Revision: 1.5 $ $Date: 2004/06/03 22:02:13 $
Author:
Stephen Colebourne
Since:
Commons Collections 3.0

Field Summary

Fields inherited from class org.apache.commons.collections.collection.TransformedCollection

transformer

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

collection

Constructor Summary

TransformedSet(Set set, Transformer transformer)
Constructor that wraps (not copies).

Method Summary

static Set
decorate(Set set, Transformer transformer)
Factory method to create a transforming set.

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

add, addAll, decorate, transform, transform

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

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

Constructor Details

TransformedSet

protected TransformedSet(Set set,
                         Transformer transformer)
Constructor that wraps (not copies).

If there are any elements already in the set being decorated, they are NOT transformed.

Parameters:
set - the set to decorate, must not be null
transformer - the transformer to use for conversion, must not be null

Method Details

decorate

public static Set decorate(Set set,
                           Transformer transformer)
Factory method to create a transforming set.

If there are any elements already in the set being decorated, they are NOT transformed.

Parameters:
set - the set to decorate, must not be null
transformer - the transformer to use for conversion, must not be null

Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.