org.apache.commons.collections4.set

Class TransformedSortedSet<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>

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

All Implemented Interfaces:

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

Direct Known Subclasses:

TransformedNavigableSet

public class TransformedSortedSet<E>
extends TransformedSet<E>
implements java.util.SortedSet<E>

Decorates another SortedSet 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
java.util.Comparator<? super E>	comparator()
E	first()
java.util.SortedSet<E>	headSet(E toElement)
E	last()
java.util.SortedSet<E>	subSet(E fromElement, E toElement)
java.util.SortedSet<E>	tailSet(E fromElement)
static <E> TransformedSortedSet<E>	transformedSortedSet(java.util.SortedSet<E> set, Transformer<? super E,? extends E> transformer) Factory method to create a transforming sorted set that will transform existing contents of the specified sorted set.
static <E> TransformedSortedSet<E>	transformingSortedSet(java.util.SortedSet<E> set, Transformer<? super E,? extends E> transformer) Factory method to create a transforming sorted set.

Methods inherited from class org.apache.commons.collections4.set.TransformedSet

equals, hashCode, transformedSet, transformingSet

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.SortedSet

spliterator

Methods inherited from interface java.util.Set

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

transformingSortedSet

public static <E> TransformedSortedSet<E> transformingSortedSet(java.util.SortedSet<E> set,
                                                                Transformer<? super E,? extends E> transformer)

Factory method to create a transforming sorted set.

If there are any elements already in the set being decorated, they are NOT transformed. Contrast this with transformedSortedSet(SortedSet, 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 SortedSet

Throws:

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

Since:

4.0

transformedSortedSet

public static <E> TransformedSortedSet<E> transformedSortedSet(java.util.SortedSet<E> set,
                                                               Transformer<? super E,? extends E> transformer)

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

If there are any elements already in the set being decorated, they will be transformed by this method. Contrast this with transformingSortedSet(SortedSet, 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 SortedSet

Throws:

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

Since:

4.0

first

public E first()

Specified by:

first in interface java.util.SortedSet<E>

last

public E last()

Specified by:

last in interface java.util.SortedSet<E>

comparator

public java.util.Comparator<? super E> comparator()

Specified by:

comparator in interface java.util.SortedSet<E>

subSet

public java.util.SortedSet<E> subSet(E fromElement,
                                     E toElement)

Specified by:

subSet in interface java.util.SortedSet<E>

headSet

public java.util.SortedSet<E> headSet(E toElement)

Specified by:

headSet in interface java.util.SortedSet<E>

tailSet

public java.util.SortedSet<E> tailSet(E fromElement)

Specified by:

tailSet in interface java.util.SortedSet<E>