org.apache.commons.collections.set

Class TransformedSortedSet

Implemented Interfaces:
Collection, Serializable, 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.

This class is Serializable from Commons Collections 3.1.

Version:
$Revision: 1.5 $ $Date: 2004/06/03 22:02:13 $
Author:
Stephen Colebourne
Since:
Commons Collections 3.0

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

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()
protected SortedSet
getSortedSet()
Gets the decorated set.
SortedSet
headSet(Object toElement)
Object
last()
SortedSet
subSet(Object fromElement, Object toElement)
SortedSet
tailSet(Object fromElement)

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

decorate

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

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

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

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

first

public Object first()

getSortedSet

protected SortedSet getSortedSet()
Gets the decorated set.
Returns:
the decorated set

headSet

public SortedSet headSet(Object toElement)

last

public Object last()

subSet

public SortedSet subSet(Object fromElement,
                        Object toElement)

tailSet

public SortedSet tailSet(Object fromElement)

Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.