Package 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>
@GwtCompatible(emulated=true) public final class EnumHashBiMap<K extends java.lang.Enum<K>,V> extends ForwardingMap<K,V>
ABiMap
backed by anEnumMap
instance for keys-to-values, and aHashMap
instance for values-to-keys. Null keys are not permitted, but null values are. AnEnumHashBiMap
and its inverse are both serializable.See the Guava User Guide article on
BiMap
.- Since:
- 2.0 (imported from Google Collections Library)
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
boolean
containsValue(java.lang.Object value)
static <K extends java.lang.Enum<K>,V>
EnumHashBiMap<K,V>create(java.lang.Class<K> keyType)
Returns a new, emptyEnumHashBiMap
using the specified key type.static <K extends java.lang.Enum<K>,V>
EnumHashBiMap<K,V>create(java.util.Map<K,? extends V> map)
Constructs a new bimap with the same mappings as the specified map.java.util.Set<java.util.Map.Entry<K,V>>
entrySet()
V
forcePut(K key, V value)
An alternate form ofput
that silently removes any existing entry with the valuevalue
before proceeding with theBiMap.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, equals, get, hashCode, isEmpty, size
-
Methods inherited from class com.google.common.collect.ForwardingObject
toString
-
-
-
-
Method Detail
-
create
public static <K extends java.lang.Enum<K>,V> EnumHashBiMap<K,V> create(java.lang.Class<K> keyType)
Returns a new, emptyEnumHashBiMap
using the specified key type.- Parameters:
keyType
- the key type
-
create
public static <K extends java.lang.Enum<K>,V> EnumHashBiMap<K,V> create(java.util.Map<K,? extends V> map)
Constructs a new bimap with the same mappings as the specified map. If the specified map is anEnumHashBiMap
or anEnumBiMap
, the new bimap has the same key type as the input bimap. Otherwise, the specified map must contain at least one mapping, in order to determine the key type.- Parameters:
map
- the map whose mappings are to be placed in this map- Throws:
java.lang.IllegalArgumentException
- if map is not anEnumBiMap
or anEnumHashBiMap
instance and contains no mappings
-
forcePut
public V forcePut(K key, @Nullable V value)
Description copied from interface:BiMap
An alternate form ofput
that silently removes any existing entry with the valuevalue
before proceeding with theBiMap.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 interfaceBiMap<K extends java.lang.Enum<K>,V>
- Parameters:
key
- the key with which the specified value is to be associatedvalue
- the value to be associated with the specified key- Returns:
- the value which was previously associated with the key, which may
be
null
, ornull
if there was no previous entry
-
keyType
public java.lang.Class<K> keyType()
Returns the associated key type.
-
containsValue
public boolean containsValue(@Nullable java.lang.Object value)
- Specified by:
containsValue
in interfacejava.util.Map<K,V>
- Overrides:
containsValue
in classForwardingMap<K,V>
-
remove
public V remove(@Nullable java.lang.Object key)
- Specified by:
remove
in interfacejava.util.Map<K,V>
- Overrides:
remove
in classForwardingMap<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 interfaceBiMap<K,V>
- Specified by:
putAll
in interfacejava.util.Map<K,V>
- Overrides:
putAll
in classForwardingMap<K,V>
-
clear
public void clear()
- Specified by:
clear
in interfacejava.util.Map<K,V>
- Overrides:
clear
in classForwardingMap<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.
-
keySet
public java.util.Set<K> keySet()
- Specified by:
keySet
in interfacejava.util.Map<K,V>
- Overrides:
keySet
in classForwardingMap<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 theCollection
specified in theMap
interface.- Specified by:
values
in interfaceBiMap<K,V>
- Specified by:
values
in interfacejava.util.Map<K,V>
- Overrides:
values
in classForwardingMap<K,V>
-
entrySet
public java.util.Set<java.util.Map.Entry<K,V>> entrySet()
- Specified by:
entrySet
in interfacejava.util.Map<K,V>
- Overrides:
entrySet
in classForwardingMap<K,V>
-
-