org.josef.util

Class BiDirectionalMap<K,V>

java.lang.Object

org.josef.util.BiDirectionalMap<K,V>

Type Parameters:

K - Type of the keys.

V - Type of the values.

@ThreadSafety(level=NOT_THREAD_SAFE,
              doc="Please initialize your maps with a static initializer")
public final class BiDirectionalMap<K,V>
extends Object

Bidirectional Map, mapping keys to values and vice versa.
A separate map is used to map values back to keys, so the performance of this class is much better than the linear performance you would get with a single map, when looking for values that are mapped to keys.
Please consider using EnumMapper when mapping two enumerated types.

Version:

$Revision: 6488 $

Author:

Rens van Leeuwen, Kees Schotanus

Constructor Summary

Constructors

Constructor and Description
BiDirectionalMap(Class<K> keyClass, Class<V> valueClass) Constructs this BiDirectionalMap from the supplied keyClass and valueClass.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(K key) Determines whether the supplied key is mapped to a value.
boolean	containsValue(V value) Determines whether the supplied value is mapped to a key.
K	getKey(V value) Gets the key that is mapped to the supplied value.
V	getValue(K key) Gets the value that is mapped to the supplied key.
void	map(K key, V value) Maps the supplied key to the supplied value and vice versa.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BiDirectionalMap

public BiDirectionalMap(Class<K> keyClass,
                        Class<V> valueClass)

Constructs this BiDirectionalMap from the supplied keyClass and valueClass.
After creation the maps will be empty.

Parameters:

keyClass - The class type of the keys.

valueClass - The class type of the values.

Throws:

NullPointerException - When either the supplied keyClass or the supplied valueClass is null.

Method Detail

map

public void map(K key,
                V value)

Maps the supplied key to the supplied value and vice versa.

Parameters:

key - The key.

value - The value.

Throws:

NullPointerException - When either the supplied key or value is null.

containsKey

public boolean containsKey(K key)

Determines whether the supplied key is mapped to a value.

Parameters:

key - The key to check for a mapped value.

Returns:

True when the supplied key is mapped to a value, otherwise false is returned.

getValue

public V getValue(K key)

Gets the value that is mapped to the supplied key.

Parameters:

key - The key to get the mapped value of.

Returns:

The value mapped to the supplied key.

Throws:

IllegalArgumentException - When the supplied key has not been mapped.

NullPointerException - when the supplied key is null.

containsValue

public boolean containsValue(V value)

Determines whether the supplied value is mapped to a key.

Parameters:

value - The value to check for a mapped key.

Returns:

True when the supplied value is mapped to a key, otherwise false is returned.

getKey

public K getKey(V value)

Gets the key that is mapped to the supplied value.

Parameters:

value - The value to get the mapped key of.

Returns:

The key that is mapped to the supplied value.

Throws:

IllegalArgumentException - When the supplied value has not been mapped.

NullPointerException - when the supplied value is null.