org.apache.commons.collections.set
Class TransformedSet

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

All Implemented Interfaces:

java.util.Collection, java.util.Set

Direct Known Subclasses:

TransformedSortedSet

public class TransformedSet

extends TransformedCollection

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

Since:

Commons Collections 3.0

Version:

$Revision: 1.2 $ $Date: 2004/01/14 21:43:13 $

Author:

Stephen Colebourne

Method Summary

static java.util.Set

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

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

add, addAll, decorate

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

Methods inherited from interface java.util.Set

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

Method Detail

decorate

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

Throws:

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