org.apache.commons.collections.bidimap

Class AbstractSortedBidiMapDecorator

java.lang.Object
|
+--org.apache.commons.collections.map.AbstractMapDecorator
   |
   +--org.apache.commons.collections.bidimap.AbstractBidiMapDecorator
      |
      +--org.apache.commons.collections.bidimap.AbstractOrderedBidiMapDecorator
         |
         +--org.apache.commons.collections.bidimap.AbstractSortedBidiMapDecorator

All Implemented Interfaces:
Map, BidiMap, OrderedBidiMap, SortedBidiMap

Known Direct Subclasses:
UnmodifiableSortedBidiMap

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

Author:

Stephen Colebourne

Constructor Summary

AbstractSortedBidiMapDecorator(SortedBidiMap map)

Constructor that wraps (not copies).

Method Summary

Comparator	comparator()
SortedBidiMap	getSortedBidiMap() Gets the map being decorated.
SortedMap	headMap(Object toKey)
SortedBidiMap	inverseSortedBidiMap()
SortedMap	subMap(Object fromKey, Object toKey)
SortedMap	tailMap(Object fromKey)

Constructor Details

AbstractSortedBidiMapDecorator

public AbstractSortedBidiMapDecorator(SortedBidiMap map)

Constructor that wraps (not copies).

Parameters:

map - the map to decorate, must not be null

Throws:

- if the collection is null

`Method Details`

comparator
public Comparator comparator()
getSortedBidiMap
protected SortedBidiMap getSortedBidiMap()
 Gets the map being decorated.
Returns:
the decorated map
headMap
public SortedMap headMap(Object toKey)
Parameters:
toKey
inverseSortedBidiMap
public SortedBidiMap inverseSortedBidiMap()
subMap
public SortedMap subMap(Object fromKey, Object toKey)
Parameters:
fromKey
toKey
tailMap
public SortedMap tailMap(Object fromKey)
Parameters:
fromKey
Generated on
  February 15, 2004
  by GNU Classpath Tools (Gjdoc XmlDoclet 0.6.1).