Class EnumHashBiMap<K extends Enum<K>,V extends @Nullable Object>
- 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>
,Serializable
,Map<K,V>
@GwtCompatible(emulated=true) public final class EnumHashBiMap<K extends Enum<K>,V extends @Nullable Object> 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
- Author:
- Mike Bostock
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.common.collect.ForwardingMap
ForwardingMap.StandardEntrySet, ForwardingMap.StandardKeySet, ForwardingMap.StandardValues
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
Removes all of the mappings from this map (optional operation).boolean
containsValue(Object value)
Returnstrue
if this map maps one or more keys to the specified value.static <K extends Enum<K>,V extends @Nullable Object>
EnumHashBiMap<K,V>create(Class<K> keyType)
Returns a new, emptyEnumHashBiMap
using the specified key type.static <K extends Enum<K>,V extends @Nullable Object>
EnumHashBiMap<K,V>create(Map<K,? extends V> map)
Constructs a new bimap with the same mappings as the specified map.protected Map<K,V>
delegate()
Returns the backing delegate instance that methods are forwarded to.Set<Map.Entry<K,V>>
entrySet()
Returns aSet
view of the mappings contained in this map.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.Set<K>
keySet()
Returns aSet
view of the keys contained in this map.Class<K>
keyType()
Returns the associated key type.V
put(K key, V value)
Associates the specified value with the specified key in this map (optional operation).void
putAll(Map<? extends K,? extends V> map)
Copies all of the mappings from the specified map to this map (optional operation).V
remove(Object key)
Removes the mapping for a key from this map if it is present (optional operation).Set<V>
values()
Returns aCollection
view of the values contained in this map.-
Methods inherited from class com.google.common.collect.ForwardingMap
containsKey, equals, get, hashCode, isEmpty, size, standardClear, standardContainsKey, standardContainsValue, standardEquals, standardHashCode, standardIsEmpty, standardPutAll, standardRemove, standardToString
-
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
compute, computeIfAbsent, computeIfPresent, containsKey, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size
-
-
-
-
Method Detail
-
create
public static <K extends Enum<K>,V extends @Nullable Object> EnumHashBiMap<K,V> create(Class<K> keyType)
Returns a new, emptyEnumHashBiMap
using the specified key type.- Parameters:
keyType
- the key type
-
create
public static <K extends Enum<K>,V extends @Nullable Object> EnumHashBiMap<K,V> create(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:
IllegalArgumentException
- if map is not anEnumBiMap
or anEnumHashBiMap
instance and contains no mappings
-
put
@CanIgnoreReturnValue @CheckForNull public V put(K key, V value)
Description copied from interface:java.util.Map
Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A mapm
is said to contain a mapping for a keyk
if and only ifm.containsKey(k)
would returntrue
.)- Specified by:
put
in interfaceBiMap<K extends Enum<K>,V extends @Nullable Object>
- Specified by:
put
in interfaceMap<K extends Enum<K>,V extends @Nullable Object>
- Parameters:
key
- key with which the specified value is to be associatedvalue
- value to be associated with the specified key- Returns:
- the previous value associated with
key
, ornull
if there was no mapping forkey
. (Anull
return can also indicate that the map previously associatednull
withkey
, if the implementation supportsnull
values.)
-
forcePut
@CanIgnoreReturnValue @CheckForNull public V forcePut(K key, 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 Enum<K>,V extends @Nullable Object>
- 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 that was previously associated with the key, or
null
if there was no previous entry. (If the bimap contains null values, thenforcePut
, likeput
, returnsnull
both if the key is absent and if it is present with a null value.)
-
delegate
protected Map<K,V> delegate()
Description copied from class:ForwardingObject
Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such asForwardingSet.delegate()
. Concrete subclasses override this method to supply the instance being decorated.
-
containsValue
public boolean containsValue(@CheckForNull Object value)
Description copied from interface:java.util.Map
Returnstrue
if this map maps one or more keys to the specified value. More formally, returnstrue
if and only if this map contains at least one mapping to a valuev
such thatObjects.equals(value, v)
. This operation will probably require time linear in the map size for most implementations of theMap
interface.- Specified by:
containsValue
in interfaceMap<K extends @Nullable Object,V extends @Nullable Object>
- Overrides:
containsValue
in classForwardingMap<K extends @Nullable Object,V extends @Nullable Object>
- Parameters:
value
- value whose presence in this map is to be tested- Returns:
true
if this map maps one or more keys to the specified value
-
remove
@CanIgnoreReturnValue @CheckForNull public V remove(@CheckForNull Object key)
Description copied from interface:java.util.Map
Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from keyk
to valuev
such thatObjects.equals(key, k)
, that mapping is removed. (The map can contain at most one such mapping.)Returns the value to which this map previously associated the key, or
null
if the map contained no mapping for the key.If this map permits null values, then a return value of
null
does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key tonull
.The map will not contain a mapping for the specified key once the call returns.
- Specified by:
remove
in interfaceMap<K extends @Nullable Object,V extends @Nullable Object>
- Overrides:
remove
in classForwardingMap<K extends @Nullable Object,V extends @Nullable Object>
- Parameters:
key
- key whose mapping is to be removed from the map- Returns:
- the previous value associated with
key
, ornull
if there was no mapping forkey
.
-
putAll
public void putAll(Map<? extends K,? extends V> map)
Description copied from interface:java.util.Map
Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of callingput(k, v)
on this map once for each mapping from keyk
to valuev
in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress.- Specified by:
putAll
in interfaceBiMap<K extends @Nullable Object,V extends @Nullable Object>
- Specified by:
putAll
in interfaceMap<K extends @Nullable Object,V extends @Nullable Object>
- Overrides:
putAll
in classForwardingMap<K extends @Nullable Object,V extends @Nullable Object>
- Parameters:
map
- mappings to be stored in this map
-
clear
public void clear()
Description copied from interface:java.util.Map
Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
-
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 Set<K> keySet()
Description copied from interface:java.util.Map
Returns aSet
view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's ownremove
operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via theIterator.remove
,Set.remove
,removeAll
,retainAll
, andclear
operations. It does not support theadd
oraddAll
operations.
-
values
public Set<V> values()
Description copied from interface:java.util.Map
Returns aCollection
view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's ownremove
operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via theIterator.remove
,Collection.remove
,removeAll
,retainAll
andclear
operations. It does not support theadd
oraddAll
operations.- Specified by:
values
in interfaceBiMap<K extends @Nullable Object,V extends @Nullable Object>
- Specified by:
values
in interfaceMap<K extends @Nullable Object,V extends @Nullable Object>
- Overrides:
values
in classForwardingMap<K extends @Nullable Object,V extends @Nullable Object>
- Returns:
- a collection view of the values contained in this map
-
entrySet
public Set<Map.Entry<K,V>> entrySet()
Description copied from interface:java.util.Map
Returns aSet
view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's ownremove
operation, or through thesetValue
operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via theIterator.remove
,Set.remove
,removeAll
,retainAll
andclear
operations. It does not support theadd
oraddAll
operations.
-
-