⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
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:
Collection, 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.

Since:
Commons Collections 3.0
Author:
Stephen Colebourne

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.

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
Throws:
- if set or transformer is 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
Throws:
- if set or transformer is null