org.apache.commons.collections.bidimap

Class AbstractBidiMapDecorator

public abstract class AbstractBidiMapDecorator extends AbstractMapDecorator implements BidiMap

Provides a base decorator that enables additional functionality to be added to a BidiMap 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 set/collection 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 AbstractBidiMapDecorator(BidiMap map)
Constructor that wraps (not copies).
Method Summary
protected BidiMapgetBidiMap()
Gets the map being decorated.
ObjectgetKey(Object value)
BidiMapinverseBidiMap()
MapIteratormapIterator()
ObjectremoveValue(Object value)

Constructor Detail

AbstractBidiMapDecorator

protected AbstractBidiMapDecorator(BidiMap 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

getBidiMap

protected BidiMap getBidiMap()
Gets the map being decorated.

Returns: the decorated map

getKey

public Object getKey(Object value)

inverseBidiMap

public BidiMap inverseBidiMap()

mapIterator

public MapIterator mapIterator()

removeValue

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