⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.apache.commons.collections.set

Class TransformedSortedSet

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

All Implemented Interfaces:
Collection, Set, SortedSet


public class TransformedSortedSet
extends TransformedSet
implements SortedSet

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.

Since:
Commons Collections 3.0
Author:
Stephen Colebourne

Constructor Summary

TransformedSortedSet(SortedSet set, Transformer transformer)

Constructor that wraps (not copies).

Method Summary

Comparator

comparator()

static SortedSet

decorate(SortedSet set, Transformer transformer)

Factory method to create a transforming sorted set.

Object

first()

SortedSet

getSortedSet()

Gets the decorated set.

SortedSet

headSet(Object toElement)

Object

last()

SortedSet

subSet(Object fromElement, Object toElement)

SortedSet

tailSet(Object fromElement)

Constructor Details

TransformedSortedSet

protected TransformedSortedSet(SortedSet 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

comparator

public Comparator comparator()


decorate

public static SortedSet decorate(SortedSet set, Transformer transformer)

Factory method to create a transforming sorted 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

first

public Object first()


getSortedSet

protected SortedSet getSortedSet()

Gets the decorated set.

Returns:
the decorated set

headSet

public SortedSet headSet(Object toElement)

Parameters:
toElement

last

public Object last()


subSet

public SortedSet subSet(Object fromElement, Object toElement)

Parameters:
fromElement
toElement

tailSet

public SortedSet tailSet(Object fromElement)

Parameters:
fromElement