⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.apache.commons.collections.bidimap

Class AbstractBidiMapDecorator

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

All Implemented Interfaces:
Map, BidiMap

Known Direct Subclasses:
AbstractOrderedBidiMapDecorator, UnmodifiableBidiMap


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
Author:
Stephen Colebourne

Constructor Summary

AbstractBidiMapDecorator(BidiMap map)

Constructor that wraps (not copies).

Method Summary

BidiMap

getBidiMap()

Gets the map being decorated.

Object

getKey(Object value)

BidiMap

inverseBidiMap()

MapIterator

mapIterator()

Object

removeValue(Object value)

Constructor Details

AbstractBidiMapDecorator

protected AbstractBidiMapDecorator(BidiMap map)

Constructor that wraps (not copies).

Parameters:
map - the map to decorate, must not be null
Throws:
- if the collection is null

Method Details

getBidiMap

protected BidiMap getBidiMap()

Gets the map being decorated.

Returns:
the decorated map

getKey

public Object getKey(Object value)

Parameters:
value

inverseBidiMap

public BidiMap inverseBidiMap()


mapIterator

public MapIterator mapIterator()


removeValue

public Object removeValue(Object value)

Parameters:
value