org.apache.commons.collections4.set

Class TransformedSet<E>

java.lang.Object

org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>

org.apache.commons.collections4.collection.TransformedCollection<E>

org.apache.commons.collections4.set.TransformedSet<E>

Type Parameters:

E - the type of the elements in this set

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>

Direct Known Subclasses:

TransformedSortedSet

public class TransformedSet<E>
extends TransformedCollection<E>
implements java.util.Set<E>

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:

3.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object)
int	hashCode()
static <E> java.util.Set<E>	transformedSet(java.util.Set<E> set, Transformer<? super E,? extends E> transformer) Factory method to create a transforming set that will transform existing contents of the specified set.
static <E> TransformedSet<E>	transformingSet(java.util.Set<E> set, Transformer<? super E,? extends E> transformer) Factory method to create a transforming set.

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

add, addAll, transformedCollection, transformingCollection

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

clear, contains, containsAll, 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, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

transformingSet

public static <E> TransformedSet<E> transformingSet(java.util.Set<E> set,
                                                    Transformer<? super E,? extends E> transformer)

Factory method to create a transforming set.

If there are any elements already in the set being decorated, they are NOT transformed. Contrast this with transformedSet(Set, Transformer).

Type Parameters:

E - the element type

Parameters:

set - the set to decorate, must not be null

transformer - the transformer to use for conversion, must not be null

Returns:

a new transformed set

Throws:

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

Since:

4.0

transformedSet

public static <E> java.util.Set<E> transformedSet(java.util.Set<E> set,
                                                  Transformer<? super E,? extends E> transformer)

Factory method to create a transforming set that will transform existing contents of the specified set.

If there are any elements already in the set being decorated, they will be transformed by this method. Contrast this with transformingSet(Set, Transformer).

Type Parameters:

E - the element type

Parameters:

set - the set to decorate, must not be null

transformer - the transformer to use for conversion, must not be null

Returns:

a new transformed set

Throws:

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

Since:

4.0

equals

public boolean equals(java.lang.Object object)

Specified by:

equals in interface java.util.Collection<E>

Specified by:

equals in interface java.util.Set<E>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<E>

Specified by:

hashCode in interface java.util.Set<E>

Overrides:

hashCode in class java.lang.Object