edu.ucla.sspace.util

Class HashBiMap<K,V>

java.lang.Object

edu.ucla.sspace.util.HashBiMap<K,V>

All Implemented Interfaces:

BiMap<K,V>, Serializable, Map<K,V>

public class HashBiMap<K,V>
extends Object
implements BiMap<K,V>, Serializable

A HashMap based implementation of a BiMap. Given an existing Map, all values will be mapped to their original keys in a new hash map.

Author:

Keith Stevens

See Also:

Serialized Form

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
HashBiMap() Creates an empty HashBiMap
HashBiMap(Map<K,V> map) Creates a new HashBiMap from an existing Map

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object key)
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(Object o)
V	get(Object o)
int	hashCode()
BiMap<V,K>	inverse() Returns a reversed form of this BiMap, where values in this BiMap will map to keys in this BiMap.
boolean	isEmpty()
Set<K>	keySet()
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> m)
V	remove(Object key)
int	size()
String	toString() Returns a string description of the mappings.
Collection<V>	values()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HashBiMap

public HashBiMap()

Creates an empty HashBiMap

HashBiMap

public HashBiMap(Map<K,V> map)

Creates a new HashBiMap from an existing Map

Throws:

IllegalArgumentException - if the mapping is not bijective

Method Detail

clear

public void clear()

Specified by:

clear in interface Map<K,V>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

containsValue

public boolean containsValue(Object key)

Specified by:

containsValue in interface Map<K,V>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

get

public V get(Object o)

Specified by:

get in interface Map<K,V>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

inverse

public BiMap<V,K> inverse()

Returns a reversed form of this BiMap, where values in this BiMap will map to keys in this BiMap. Calling inverse on the returned BiMap should return a pointer to the original BiMap.

Specified by:

inverse in interface BiMap<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

put

public V put(K key,
    V value)

Specified by:

put in interface Map<K,V>

putAll

public void putAll(Map<? extends K,? extends V> m)

Specified by:

putAll in interface Map<K,V>

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

size

public int size()

Specified by:

size in interface Map<K,V>

toString

public String toString()

Returns a string description of the mappings.

Overrides:

toString in class Object

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>