@GwtCompatible(emulated=true) public final class EnumHashBiMap<K extends java.lang.Enum<K>,V> extends ForwardingMap<K,V>
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. An EnumHashBiMap
and its inverse are both serializable.
See the Guava User Guide article on BiMap
.
ForwardingMap.StandardEntrySet, ForwardingMap.StandardKeySet, ForwardingMap.StandardValues
Modifier and Type | Method and Description |
---|---|
void |
clear() |
boolean |
containsValue(@Nullable java.lang.Object value) |
static <K extends java.lang.Enum<K>,V> |
create(java.lang.Class<K> keyType)
Returns a new, empty
EnumHashBiMap using the specified key type. |
static <K extends java.lang.Enum<K>,V> |
create(java.util.Map<K,? extends V> map)
Constructs a new bimap with the same mappings as the specified map.
|
protected java.util.Map<K,V> |
delegate()
Returns the backing delegate instance that methods are forwarded to.
|
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(@Nullable java.lang.Object key) |
void |
replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function) |
java.util.Set<V> |
values() |
containsKey, equals, get, hashCode, isEmpty, size, standardClear, standardContainsKey, standardContainsValue, standardEquals, standardHashCode, standardIsEmpty, standardPutAll, standardRemove, standardToString
toString
public static <K extends java.lang.Enum<K>,V> EnumHashBiMap<K,V> create(java.lang.Class<K> keyType)
EnumHashBiMap
using the specified key type.keyType
- the key typepublic static <K extends java.lang.Enum<K>,V> EnumHashBiMap<K,V> create(java.util.Map<K,? extends V> map)
EnumHashBiMap
or an EnumBiMap
, 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.map
- the map whose mappings are to be placed in this mapjava.lang.IllegalArgumentException
- if map is not an EnumBiMap
or an EnumHashBiMap
instance and contains no mappings@CanIgnoreReturnValue public V forcePut(K key, V value)
BiMap
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.
forcePut
in interface BiMap<K extends java.lang.Enum<K>,V>
key
- the key with which the specified value is to be associatedvalue
- the value to be associated with the specified keynull
, or
null
if there was no previous entryprotected java.util.Map<K,V> delegate()
ForwardingObject
ForwardingSet.delegate()
. Concrete subclasses override this method to supply the
instance being decorated.delegate
in class ForwardingMap<K,V>
public boolean containsValue(@Nullable java.lang.Object value)
containsValue
in interface java.util.Map<K,V>
containsValue
in class ForwardingMap<K,V>
@CanIgnoreReturnValue public V remove(@Nullable java.lang.Object key)
remove
in interface java.util.Map<K,V>
remove
in class ForwardingMap<K,V>
public void putAll(java.util.Map<? extends K,? extends V> map)
BiMap
Warning: the results of calling this method may vary depending on the iteration order
of map
.
putAll
in interface BiMap<K,V>
putAll
in interface java.util.Map<K,V>
putAll
in class ForwardingMap<K,V>
public void replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function)
replaceAll
in interface java.util.Map<K,V>
public void clear()
clear
in interface java.util.Map<K,V>
clear
in class ForwardingMap<K,V>
public BiMap<V,K> inverse()
BiMap
Note:There is no guaranteed correspondence between the iteration order of a bimap and that of its inverse.
public java.util.Set<K> keySet()
keySet
in interface java.util.Map<K,V>
keySet
in class ForwardingMap<K,V>
public java.util.Set<V> values()
BiMap
Because a bimap has unique values, this method returns a Set
, instead of the Collection
specified in the Map
interface.
values
in interface BiMap<K,V>
values
in interface java.util.Map<K,V>
values
in class ForwardingMap<K,V>
public java.util.Set<java.util.Map.Entry<K,V>> entrySet()
entrySet
in interface java.util.Map<K,V>
entrySet
in class ForwardingMap<K,V>
Copyright © 2010–2019 JBoss by Red Hat. All rights reserved.