be.yildizgames.common.collection

Class BidirectionalMap<K,V>

java.lang.Object

be.yildizgames.common.collection.BidirectionalMap<K,V>

Type Parameters:

K - Type for the keys.

V - Type for the values.

All Implemented Interfaces:

Iterable<Map.Entry<K,V>>

public final class BidirectionalMap<K,V>
extends Object
implements Iterable<Map.Entry<K,V>>

Wrap 2 Maps to easily get a value from a key and key a key from a value. The mapping must be 1 - 1, only one value for a key.

Author:

Grégory Van den Borre

Constructor Summary

Constructors

Constructor and Description
BidirectionalMap()

Method Summary

Modifier and Type	Method and Description
K	getKey(Object value) Retrieve a key from a value.
K	getKeyOr(V value, K replacementValue) Get a key from a value, or return the given one.
List<K>	getKeys()
V	getValue(K key) Retrieve the value from the key.
List<V>	getValues()
Iterator<Map.Entry<K,V>>	iterator()
void	put(K key, V value) Add a key and its value to the map.
void	remove(K key) Remove a key and its values from the containers.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

BidirectionalMap

public BidirectionalMap()

Method Detail

getKey

public K getKey(Object value)

Retrieve a key from a value.

Parameters:

value - Stored value.

Returns:

Associated key.

getKeyOr

public K getKeyOr(V value,
                  K replacementValue)

Get a key from a value, or return the given one.

Parameters:

value - Value matching the key.

replacementValue - Value to return in case if the given does not match the key.

Returns:

The matching key, or the replacement value.

getValue

public V getValue(K key)

Retrieve the value from the key.

Parameters:

key - Stored key.

Returns:

Associated value.

iterator

public Iterator<Map.Entry<K,V>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<K,V>>

put

public void put(K key,
                V value)

Add a key and its value to the map.

Parameters:

key - The map key.

value - The value associated to the key.

remove

public void remove(K key)

Remove a key and its values from the containers.

Parameters:

key - Object to remove.

getValues

public List<V> getValues()

getKeys

public List<K> getKeys()