com.google.common.collect
Class EnumBiMap<K extends Enum<K>,V extends Enum<V>>

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

All Implemented Interfaces:

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

public final class EnumBiMap<K extends Enum<K>,V extends Enum<V>>
extends ForwardingMap<K,V>

A BiMap backed by two EnumMap instances. Null keys and values are not permitted.

Author:

Mike Bostock

See Also:

Serialized Form

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

EnumBiMap(Class<K> keyType, Class<V> valueType)
Constructs a new empty bimap using the specified key type and value type.

EnumBiMap(EnumBiMap<K,V> map)
Constructs a new bimap with the same mappings as the specified map.

EnumBiMap(Map<K,V> map)
Constructs a new bimap with the same mappings as the specified map.

Method Summary

void	clear()
boolean	containsValue(Object value)
Set<Map.Entry<K,V>>	entrySet()
V	forcePut(K key, V value) An alternate form of put which silently removes any existing entry with the value value (unless it is already matched with the key key) 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.
Set<K>	keySet()
Class<K>	keyType() Returns the associated key type.
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> map)
V	remove(Object key)
Set<V>	values()
Class<V>	valueType() Returns the associated value type.

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

EnumBiMap

public EnumBiMap(Class<K> keyType,
                 Class<V> valueType)

Constructs a new empty bimap using the specified key type and value type.

Parameters:

keyType - the key type

valueType - the value type

EnumBiMap

public EnumBiMap(EnumBiMap<K,V> map)

Constructs a new bimap with the same mappings as the specified map.

Parameters:

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

EnumBiMap

public EnumBiMap(Map<K,V> map)

Constructs a new bimap with the same mappings as the specified map. If the specified map is an EnumBiMap instance, this constructor behaves identically to EnumBiMap(EnumBiMap). 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:

IllegalArgumentException - if map is not an EnumBiMap instance and contains no mappings

Method Detail

keyType

public Class<K> keyType()

Returns the associated key type.

valueType

public Class<V> valueType()

Returns the associated value type.

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

Overrides:

containsValue in class ForwardingMap<K,V>

put

public V put(K key,
             V value)

Description copied from interface: BiMap

Specified by:

put in interface BiMap<K,V>

Specified by:

put in interface Map<K,V>

Overrides:

put in class ForwardingMap<K,V>

forcePut

public V forcePut(K key,
                  V value)

Description copied from interface: BiMap

An alternate form of put which silently removes any existing entry with the value value (unless it is already matched with the key key) before proceeding with the BiMap.put(K, V) operation. 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 this entry is discarded and not returned.

Specified by:

forcePut in interface BiMap<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

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class ForwardingMap<K,V>

putAll

public void putAll(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 Map<K,V>

Overrides:

putAll in class ForwardingMap<K,V>

clear

public void clear()

Specified by:

clear in interface 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 Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

Overrides:

keySet in class ForwardingMap<K,V>

values

public 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 Map<K,V>

Overrides:

values in class ForwardingMap<K,V>

entrySet

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

Specified by:

entrySet in interface Map<K,V>

Overrides:

entrySet in class ForwardingMap<K,V>