com.google.common.collect
Class EnumHashBiMap<K extends java.lang.Enum<K>,V>

java.lang.Object
  com.google.common.collect.ForwardingObject
      com.google.common.collect.ForwardingMap<K,V>
          com.google.common.collect.EnumHashBiMap<K,V>

All Implemented Interfaces:

BiMap<K,V>, java.io.Serializable, java.util.Map<K,V>

public final class EnumHashBiMap<K extends java.lang.Enum<K>,V>
extends ForwardingMap<K,V>

A BiMap backed by an EnumMap instance for keys-to-values, and a HashMap instance for values-to-keys. Null keys are not permitted, but null values are.

Author:

Mike Bostock

See Also:

EnumMap, HashMap, Serialized Form

Nested Class Summary

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

java.util.Map.Entry<K,V>

Constructor Summary

EnumHashBiMap(java.lang.Class<K> keyType)
Constructs a new empty bimap using the specified key type, sized to contain an entry for every possible key.

EnumHashBiMap(EnumHashBiMap<K,? extends V> map)
Constructs a new bimap with the same key type as the specified map, initially containing the same mappings (if any).

EnumHashBiMap(java.util.Map<K,? extends V> map)
Constructs a new bimap with the same mappings as the specified map.

Method Summary

void	clear()
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<K,V>>	entrySet()
V	forcePut(K key, V value) An alternate form of put that silently removes any existing entry with the value value before proceeding with the BiMap.put(K, V) operation.
BiMap<V,K>	inverse() Returns the inverse view of this bimap, which maps each of this bimap's values to its associated key.
java.util.Set<K>	keySet()
java.lang.Class<K>	keyType() Returns the associated key type.
V	put(K key, V value)
void	putAll(java.util.Map<? extends K,? extends V> map)
V	remove(java.lang.Object key)
java.util.Set<V>	values()

Methods inherited from class com.google.common.collect.ForwardingMap

containsKey, delegate, equals, get, hashCode, isEmpty, size

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

containsKey, equals, get, hashCode, isEmpty, size

Constructor Detail

EnumHashBiMap

public EnumHashBiMap(java.lang.Class<K> keyType)

Constructs a new empty bimap using the specified key type, sized to contain an entry for every possible key.

Parameters:

keyType - the key type

Throws:

java.lang.NullPointerException - if any argument is null

EnumHashBiMap

public EnumHashBiMap(java.util.Map<K,? extends V> map)

Constructs a new bimap with the same mappings as the specified map. If the specified map is an EnumHashBiMap or an EnumBiMap instance, this constructor behaves identically to EnumHashBiMap(EnumHashBiMap) or EnumHashBiMap(EnumHashBiMap), respectively. Otherwise, the specified map must contain at least one mapping (in order to determine the new enum bimap's key type).

Parameters:

map - the map whose mappings are to be placed in this map

Throws:

java.lang.IllegalArgumentException - if map is not an EnumBiMap or an EnumHashBiMap instance and contains no mappings

EnumHashBiMap

public EnumHashBiMap(EnumHashBiMap<K,? extends V> map)

Constructs a new bimap with the same key type as the specified map, initially containing the same mappings (if any).

Parameters:

map - the map whose mappings are to be placed in this map

Method Detail

put

public V put(K key,
             @Nullable
             V value)

Description copied from interface: BiMap

Specified by:

put in interface BiMap<K extends java.lang.Enum<K>,V>

Specified by:

put in interface java.util.Map<K extends java.lang.Enum<K>,V>

forcePut

public V forcePut(K key,
                  @Nullable
                  V value)

Description copied from interface: BiMap

An alternate form of put that silently removes any existing entry with the value value before proceeding with the BiMap.put(K, V) operation. If the bimap previously contained the provided key-value mapping, this method has no effect.

Note that a successful call to this method could cause the size of the bimap to increase by one, stay the same, or even decrease by one.

Warning: If an existing entry with this value is removed, the key for that entry is discarded and not returned.

Specified by:

forcePut in interface BiMap<K extends java.lang.Enum<K>,V>

Parameters:

key - the key with which the specified value is to be associated

value - the value to be associated with the specified key

Returns:

the value which was previously associated with the key, which may be null, or null if there was no previous entry

keyType

public java.lang.Class<K> keyType()

Returns the associated key type.

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<K,V>

Overrides:

containsValue in class ForwardingMap<K,V>

remove

public V remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<K,V>

Overrides:

remove in class ForwardingMap<K,V>

putAll

public void putAll(java.util.Map<? extends K,? extends V> map)

Description copied from interface: BiMap

Warning: the results of calling this method may vary depending on the iteration order of map.

Specified by:

putAll in interface BiMap<K,V>

Specified by:

putAll in interface java.util.Map<K,V>

Overrides:

putAll in class ForwardingMap<K,V>

clear

public void clear()

Specified by:

clear in interface java.util.Map<K,V>

Overrides:

clear in class ForwardingMap<K,V>

inverse

public BiMap<V,K> inverse()

Description copied from interface: BiMap

Returns the inverse view of this bimap, which maps each of this bimap's values to its associated key. The two bimaps are backed by the same data; any changes to one will appear in the other.

Note:There is no guaranteed correspondence between the iteration order of a bimap and that of its inverse.

Specified by:

inverse in interface BiMap<K,V>

Returns:

the inverse view of this bimap

keySet

public java.util.Set<K> keySet()

Specified by:

keySet in interface java.util.Map<K,V>

Overrides:

keySet in class ForwardingMap<K,V>

values

public java.util.Set<V> values()

Description copied from interface: BiMap

Because a bimap has unique values, this method returns a Set, instead of the Collection specified in the Map interface.

Specified by:

values in interface BiMap<K,V>

Specified by:

values in interface java.util.Map<K,V>

Overrides:

values in class ForwardingMap<K,V>

entrySet

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

Specified by:

entrySet in interface java.util.Map<K,V>

Overrides:

entrySet in class ForwardingMap<K,V>