org.apache.commons.collections.bidimap

Class AbstractOrderedBidiMapDecorator

public abstract class AbstractOrderedBidiMapDecorator extends AbstractBidiMapDecorator implements OrderedBidiMap

Provides a base decorator that enables additional functionality to be added to an OrderedBidiMap 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
protected AbstractOrderedBidiMapDecorator(OrderedBidiMap map)
Constructor that wraps (not copies).
Method Summary
ObjectfirstKey()
protected OrderedBidiMapgetOrderedBidiMap()
Gets the map being decorated.
OrderedBidiMapinverseOrderedBidiMap()
ObjectlastKey()
ObjectnextKey(Object key)
OrderedMapIteratororderedMapIterator()
ObjectpreviousKey(Object key)

Constructor Detail

AbstractOrderedBidiMapDecorator

protected AbstractOrderedBidiMapDecorator(OrderedBidiMap 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

firstKey

public Object firstKey()

getOrderedBidiMap

protected OrderedBidiMap getOrderedBidiMap()
Gets the map being decorated.

Returns: the decorated map

inverseOrderedBidiMap

public OrderedBidiMap inverseOrderedBidiMap()

lastKey

public Object lastKey()

nextKey

public Object nextKey(Object key)

orderedMapIterator

public OrderedMapIterator orderedMapIterator()

previousKey

public Object previousKey(Object key)
Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.