@GwtCompatible(emulated=true) public final class EnumHashBiMap<K extends 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(Object value) |
static <K extends Enum<K>,V> |
create(Class<K> keyType)
Returns a new, empty
EnumHashBiMap using the specified key type. |
static <K extends Enum<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() |
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.
|
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() |
containsKey, equals, get, hashCode, isEmpty, size, standardClear, standardContainsKey, standardContainsValue, standardEquals, standardHashCode, standardIsEmpty, standardPutAll, standardRemove, standardToStringtoStringclone, finalize, getClass, notify, notifyAll, wait, wait, waitcompute, computeIfAbsent, computeIfPresent, containsKey, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, sizepublic static <K extends Enum<K>,V> EnumHashBiMap<K,V> create(Class<K> keyType)
EnumHashBiMap using the specified key type.keyType - the key typepublic static <K extends Enum<K>,V> EnumHashBiMap<K,V> create(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 mapIllegalArgumentException - if map is not an EnumBiMap or an
EnumHashBiMap instance and contains no mappingspublic V forcePut(K key, @Nullable V value)
BiMapput 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 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 Map<K,V> delegate()
ForwardingObjectForwardingSet.delegate(). Concrete subclasses override this method to supply
the instance being decorated.delegate in class ForwardingMap<K,V>public boolean containsValue(@Nullable Object value)
containsValue in interface Map<K,V>containsValue in class ForwardingMap<K,V>public void putAll(Map<? extends K,? extends V> map)
BiMapWarning: the results of calling this method may vary depending on
the iteration order of map.
public void clear()
public BiMap<V,K> inverse()
BiMapNote:There is no guaranteed correspondence between the iteration order of a bimap and that of its inverse.
public Set<V> values()
BiMapBecause a bimap has unique values, this method returns a Set,
instead of the Collection specified in the Map
interface.