Package com.google.common.collect
Class EnumHashBiMap<K extends Enum<K>,V>
java.lang.Object
com.google.common.collect.ForwardingObject
com.google.common.collect.ForwardingMap<K,V>
com.google.common.collect.AbstractBiMap<K,V>
com.google.common.collect.EnumHashBiMap<K,V>
- All Implemented Interfaces:
BiMap<K,,V> Serializable,Map<K,V>
A
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.
- Since:
- 2.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.common.collect.AbstractBiMap
AbstractBiMap.BiMapEntry, AbstractBiMap.Inverse<K,V> Nested classes/interfaces inherited from class com.google.common.collect.ForwardingMap
ForwardingMap.StandardEntrySet, ForwardingMap.StandardKeySet, ForwardingMap.StandardValues -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final longFields inherited from class com.google.common.collect.AbstractBiMap
inverse -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) KReturns its input, or throws an exception if this is not a valid key.static <K extends Enum<K>,V>
EnumHashBiMap<K, V> Returns a new, emptyEnumHashBiMapusing the specified key type.static <K extends Enum<K>,V>
EnumHashBiMap<K, V> Constructs a new bimap with the same mappings as the specified map.An alternate form ofputthat silently removes any existing entry with the valuevaluebefore proceeding with theBiMap.put(K, V)operation.keyType()Returns the associated key type.private voidreadObject(ObjectInputStream stream) private voidwriteObject(ObjectOutputStream stream) Methods inherited from class com.google.common.collect.AbstractBiMap
checkValue, clear, containsValue, delegate, entrySet, entrySetIterator, inverse, keySet, makeInverse, putAll, remove, replaceAll, setDelegates, setInverse, valuesMethods inherited from class com.google.common.collect.ForwardingMap
containsKey, equals, get, hashCode, isEmpty, size, standardClear, standardContainsKey, standardContainsValue, standardEquals, standardHashCode, standardIsEmpty, standardPutAll, standardRemove, standardToStringMethods inherited from class com.google.common.collect.ForwardingObject
toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, size
-
Field Details
-
keyTypeOrObjectUnderJ2cl
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
-
Constructor Details
-
EnumHashBiMap
-
-
Method Details
-
create
Returns a new, emptyEnumHashBiMapusing the specified key type.- Parameters:
keyType- the key type
-
create
Constructs a new bimap with the same mappings as the specified map. If the specified map is anEnumHashBiMapor 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 anEnumBiMapor anEnumHashBiMapinstance and contains no mappings
-
checkKey
Description copied from class:AbstractBiMapReturns its input, or throws an exception if this is not a valid key. -
put
Description copied from interface:BiMap -
forcePut
Description copied from interface:BiMapAn alternate form ofputthat silently removes any existing entry with the valuevaluebefore 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:
forcePutin interfaceBiMap<K extends Enum<K>,V> - Overrides:
forcePutin classAbstractBiMap<K extends 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 that was previously associated with the key, or
nullif there was no previous entry. (If the bimap contains null values, thenforcePut, likeput, returnsnullboth if the key is absent and if it is present with a null value.)
-
keyType
Returns the associated key type. -
writeObject
- Throws:
IOException
-
readObject
- Throws:
IOExceptionClassNotFoundException
-