fr.vergne.collection.util

Class ReflexiveMap<Key,Value>

java.lang.Object

fr.vergne.collection.util.ReflexiveMap<Key,Value>

Type Parameters:

Key -

Value -

All Implemented Interfaces:

Map<Key,Value>

public class ReflexiveMap<Key,Value>
extends Object
implements Map<Key,Value>

A ReflexiveMap aims at providing a Map which support a bijective relation. In other words, the Value can be considered as a key for the Key. Such Map can thus be mirrored to be able to access Keys by providing the corresponding Values. This is what is supported by the reverse() method.

Author:

Matthieu Vergne

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ReflexiveMap()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<Key,Value>>	entrySet()
protected <K,V> Map<K,V>	generateInternalMap() Internally, two different Maps are used to store the data.
Value	get(Object key)
Key	getKeyFrom(Value value)
Value	getValueFrom(Key key)
boolean	isEmpty()
Set<Key>	keySet()
Value	put(Key key, Value value)
void	putAll(Map<? extends Key,? extends Value> m)
Value	remove(Object key)
ReflexiveMap<Value,Key>	reverse()
int	size()
String	toString()
Collection<Value>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

ReflexiveMap

public ReflexiveMap()

Method Detail

generateInternalMap

protected <K,V> Map<K,V> generateInternalMap()

Internally, two different Maps are used to store the data. Each update on this ReflexiveMap correspond to an update to both these internal Maps. You can override this method to change the type of internal Map used.

Returns:

the type of map backed by this ReflexiveMap

clear

public void clear()

Specified by:

clear in interface Map<Key,Value>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<Key,Value>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<Key,Value>

entrySet

public Set<Map.Entry<Key,Value>> entrySet()

Specified by:

entrySet in interface Map<Key,Value>

get

public Value get(Object key)

Specified by:

get in interface Map<Key,Value>

getValueFrom

public Value getValueFrom(Key key)

getKeyFrom

public Key getKeyFrom(Value value)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Key,Value>

keySet

public Set<Key> keySet()

Specified by:

keySet in interface Map<Key,Value>

put

public Value put(Key key,
        Value value)

Specified by:

put in interface Map<Key,Value>

putAll

public void putAll(Map<? extends Key,? extends Value> m)

Specified by:

putAll in interface Map<Key,Value>

remove

public Value remove(Object key)

Specified by:

remove in interface Map<Key,Value>

size

public int size()

Specified by:

size in interface Map<Key,Value>

values

public Collection<Value> values()

Specified by:

values in interface Map<Key,Value>

reverse

public ReflexiveMap<Value,Key> reverse()

toString

public String toString()

Overrides:

toString in class Object