Package com.google.common.collect
Class AbstractBiMap<K,V>
java.lang.Object
com.google.common.collect.ForwardingObject
com.google.common.collect.ForwardingMap<K,V>
com.google.common.collect.AbstractBiMap<K,V>
- All Implemented Interfaces:
BiMap<K,,V> Serializable,Map<K,V>
- Direct Known Subclasses:
AbstractBiMap.Inverse,EnumBiMap,EnumHashBiMap
A general-purpose bimap implementation using any two backing
Map instances.
Note that this class contains equals() calls that keep it from supporting
IdentityHashMap backing maps.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) classprivate class(package private) static classThe inverse of any otherAbstractBiMapsubclass.private classprivate classNested classes/interfaces inherited from class com.google.common.collect.ForwardingMap
ForwardingMap.StandardEntrySet, ForwardingMap.StandardKeySet, ForwardingMap.StandardValues -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateAbstractBiMap(Map<K, V> backward, AbstractBiMap<V, K> forward) Private constructor for inverse bimap.(package private)Package-private constructor for creating a map-backed bimap. -
Method Summary
Modifier and TypeMethodDescription(package private) KReturns its input, or throws an exception if this is not a valid key.(package private) VcheckValue(V value) Returns its input, or throws an exception if this is not a valid value.voidclear()booleancontainsValue(Object value) delegate()Returns the backing delegate instance that methods are forwarded to.entrySet()An alternate form ofputthat silently removes any existing entry with the valuevaluebefore proceeding with theBiMap.put(K, V)operation.inverse()Returns the inverse view of this bimap, which maps each of this bimap's values to its associated key.keySet()(package private) AbstractBiMap<V,K> makeInverse(Map<V, K> backward) voidprivate VputInBothMaps(K key, V value, boolean force) private VremoveFromBothMaps(Object key) private voidremoveFromInverseMap(V oldValue) voidreplaceAll(BiFunction<? super K, ? super V, ? extends V> function) (package private) voidSpecifies the delegate maps going in each direction.(package private) voidsetInverse(AbstractBiMap<V, K> inverse) private voidupdateInverseMap(K key, boolean containedKey, V oldValue, V newValue) values()Methods 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
-
delegate
-
inverse
-
keySet
-
valueSet
-
entrySet
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
-
Constructor Details
-
AbstractBiMap
Package-private constructor for creating a map-backed bimap. -
AbstractBiMap
Private constructor for inverse bimap.
-
-
Method Details
-
delegate
Description copied from class:ForwardingObjectReturns 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.- Specified by:
delegatein classForwardingMap<K,V>
-
checkKey
Returns its input, or throws an exception if this is not a valid key. -
checkValue
Returns its input, or throws an exception if this is not a valid value. -
setDelegates
Specifies the delegate maps going in each direction. Called by the constructor and by subclasses during deserialization. -
makeInverse
-
setInverse
-
containsValue
- Specified by:
containsValuein interfaceMap<K,V> - Overrides:
containsValuein classForwardingMap<K,V>
-
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,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.)
-
putInBothMaps
-
updateInverseMap
-
remove
-
removeFromBothMaps
-
removeFromInverseMap
-
putAll
Description copied from interface:BiMapWarning: the results of calling this method may vary depending on the iteration order of
map. -
replaceAll
- Specified by:
replaceAllin interfaceMap<K,V>
-
clear
public void clear() -
inverse
Description copied from interface:BiMapReturns 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
-
values
Description copied from interface:BiMapBecause a bimap has unique values, this method returns a
Set, instead of theCollectionspecified in theMapinterface. -
entrySet
-
entrySetIterator
-