org.apache.commons.collections.bidimap

Class AbstractSortedBidiMapDecorator

public abstract class AbstractSortedBidiMapDecorator extends AbstractOrderedBidiMapDecorator implements SortedBidiMap

Provides a base decorator that enables additional functionality to be added to a SortedBidiMap via decoration.

Methods are forwarded directly to the decorated map.

This implementation does not perform any special processing with the map views. Instead it simply returns the inverse from the wrapped map. This may be undesirable, for example if you are trying to write a validating implementation it would provide a loophole around the validation. But, you might want that loophole, so this class is kept simple.

Since: Commons Collections 3.0

Version: $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $

Author: Stephen Colebourne

Constructor Summary
AbstractSortedBidiMapDecorator(SortedBidiMap map)
Constructor that wraps (not copies).
Method Summary
Comparatorcomparator()
protected SortedBidiMapgetSortedBidiMap()
Gets the map being decorated.
SortedMapheadMap(Object toKey)
SortedBidiMapinverseSortedBidiMap()
SortedMapsubMap(Object fromKey, Object toKey)
SortedMaptailMap(Object fromKey)

Constructor Detail

AbstractSortedBidiMapDecorator

public AbstractSortedBidiMapDecorator(SortedBidiMap map)
Constructor that wraps (not copies).

Parameters: map the map to decorate, must not be null

Throws: IllegalArgumentException if the collection is null

Method Detail

comparator

public Comparator comparator()

getSortedBidiMap

protected SortedBidiMap getSortedBidiMap()
Gets the map being decorated.

Returns: the decorated map

headMap

public SortedMap headMap(Object toKey)

inverseSortedBidiMap

public SortedBidiMap inverseSortedBidiMap()

subMap

public SortedMap subMap(Object fromKey, Object toKey)

tailMap

public SortedMap tailMap(Object fromKey)
Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.