edu.ucla.sspace.util

Interface BiMap<K,V>

All Superinterfaces:

Map<K,V>

All Known Implementing Classes:

HashBiMap

public interface BiMap<K,V>
extends Map<K,V>

This interface allows for a bi-directional mapping, where keys can map to values and values can map to keys. This is expected to be used with one-to-oen mappings.

Author:

Keith Stevens

Nested Class Summary

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

Map.Entry<K,V>

Method Summary

Methods

Modifier and Type	Method and Description
BiMap<V,K>	inverse() Returns a reversed form of this BiMap, where values in this BiMap will map to keys in this BiMap.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

inverse

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.