@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()
Removes all of the mappings from this map (optional operation).
|
boolean |
containsValue(Object value)
Returns true if this map maps one or more keys to the
specified 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()
Returns a
Set view of the mappings contained in this map. |
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()
Returns a
Set 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).
|
void |
replaceAll(BiFunction<? super K,? super V,? extends V> function)
Replaces each entry's value with the result of invoking the given
function on that entry until all entries have been processed or the
function throws an exception.
|
Set<V> |
values()
Returns a
Collection view of the values contained in this map. |
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, 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 put(K key, @Nullable V value)
java.util.Mapm.containsKey(k) would return
true.)put in interface BiMap<K extends Enum<K>,V>put in interface Map<K extends Enum<K>,V>key - key with which the specified value is to be associatedvalue - value to be associated with the specified keypublic 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)
java.util.MapcontainsValue in interface Map<K,V>containsValue in class ForwardingMap<K,V>value - value whose presence in this map is to be testedpublic V remove(@Nullable Object key)
java.util.Map(key==null ? k==null : key.equals(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 to null.
The map will not contain a mapping for the specified key once the call returns.
remove in interface Map<K,V>remove in class ForwardingMap<K,V>key - key whose mapping is to be removed from the mappublic void putAll(Map<? extends K,? extends V> map)
java.util.Mapput(k, v) on this map once
for each mapping from key k to value v in the
specified map. The behavior of this operation is undefined if the
specified map is modified while the operation is in progress.public void replaceAll(BiFunction<? super K,? super V,? extends V> function)
java.util.MapreplaceAll in interface Map<K,V>function - the function to apply to each entrypublic void clear()
java.util.Mapclear in interface Map<K,V>clear in class ForwardingMap<K,V>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<K> keySet()
java.util.MapSet 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 own remove operation), the results of
the iteration are undefined. The set supports element removal,
which removes the corresponding mapping from the map, via the
Iterator.remove, Set.remove,
removeAll, retainAll, and clear
operations. It does not support the add or addAll
operations.keySet in interface Map<K,V>keySet in class ForwardingMap<K,V>public Set<V> values()
java.util.MapCollection 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 own remove operation),
the results of the iteration are undefined. The collection
supports element removal, which removes the corresponding
mapping from the map, via the Iterator.remove,
Collection.remove, removeAll,
retainAll and clear operations. It does not
support the add or addAll operations.public Set<Map.Entry<K,V>> entrySet()
java.util.MapSet 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 own remove operation, or through the
setValue 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 the Iterator.remove,
Set.remove, removeAll, retainAll and
clear operations. It does not support the
add or addAll operations.entrySet in interface Map<K,V>entrySet in class ForwardingMap<K,V>Copyright © 2010–2017. All rights reserved.