public class

TransformedSortedBag

extends TransformedBag
implements SortedBag
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.bag.TransformedBag
           ↳ org.apache.commons.collections.bag.TransformedSortedBag

Class Overview

Decorates another SortedBag 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.

Summary

[Expand]
Inherited Fields
From class org.apache.commons.collections.collection.TransformedCollection
From class org.apache.commons.collections.collection.AbstractCollectionDecorator
Protected Constructors
TransformedSortedBag(SortedBag bag, Transformer transformer)
Constructor that wraps (not copies).
Public Methods
Comparator comparator()
Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
static SortedBag decorate(SortedBag bag, Transformer transformer)
Factory method to create a transforming sorted bag.
Object first()
Returns the first (lowest) member.
Object last()
Returns the last (highest) member.
Protected Methods
SortedBag getSortedBag()
Gets the decorated bag.
[Expand]
Inherited Methods
From class org.apache.commons.collections.bag.TransformedBag
From class org.apache.commons.collections.collection.TransformedCollection
From class org.apache.commons.collections.collection.AbstractCollectionDecorator
From class java.lang.Object
From interface java.lang.Iterable
From interface java.util.Collection
From interface org.apache.commons.collections.Bag
From interface org.apache.commons.collections.SortedBag

Protected Constructors

protected TransformedSortedBag (SortedBag bag, Transformer transformer)

Constructor that wraps (not copies).

If there are any elements already in the bag being decorated, they are NOT transformed.

Parameters
bag the bag to decorate, must not be null
transformer the transformer to use for conversion, must not be null
Throws
IllegalArgumentException if bag or transformer is null

Public Methods

public Comparator comparator ()

Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.

Returns
  • the comparator in use, or null if natural ordering

public static SortedBag decorate (SortedBag bag, Transformer transformer)

Factory method to create a transforming sorted bag.

If there are any elements already in the bag being decorated, they are NOT transformed.

Parameters
bag the bag to decorate, must not be null
transformer the transformer to use for conversion, must not be null
Returns
  • a new transformed SortedBag
Throws
IllegalArgumentException if bag or transformer is null

public Object first ()

Returns the first (lowest) member.

Returns
  • the first element in the sorted bag

public Object last ()

Returns the last (highest) member.

Returns
  • the last element in the sorted bag

Protected Methods

protected SortedBag getSortedBag ()

Gets the decorated bag.

Returns
  • the decorated bag