TransformedSet (Commons Collections 3.2.2 API)

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

All Implemented Interfaces:

Serializable, Iterable, Collection, Set

Direct Known 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.

Since:

Commons Collections 3.0

Version:

$Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $

Author:

Stephen Colebourne

See Also:

Serialized Form

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

Constructors
Modifier Constructor Description

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

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`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
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

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

- Constructor Detail
  - 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:
    
    IllegalArgumentException - if set or transformer is null
- Method Detail
  - 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:
    
    IllegalArgumentException - if set or transformer is null