Package com.google.common.collect

Class Synchronized.SynchronizedBiMap<K,V>

java.lang.Object

com.google.common.collect.Synchronized.SynchronizedObject

com.google.common.collect.Synchronized.SynchronizedMap<K,V>

com.google.common.collect.Synchronized.SynchronizedBiMap<K,V>

All Implemented Interfaces:

BiMap<K,V>, java.io.Serializable, java.util.Map<K,V>

Enclosing class:

Synchronized

static class Synchronized.SynchronizedBiMap<K,V>
extends Synchronized.SynchronizedMap<K,V>
implements BiMap<K,V>, java.io.Serializable

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
private BiMap<V,K>	inverse
private static long	serialVersionUID
private java.util.Set<V>	valueSet

Fields inherited from class com.google.common.collect.Synchronized.SynchronizedMap

entrySet, keySet, values

Fields inherited from class com.google.common.collect.Synchronized.SynchronizedObject

delegate, mutex

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SynchronizedBiMap(BiMap<K,V> delegate, java.lang.Object mutex, BiMap<V,K> inverse)

Method Summary

Modifier and Type	Method	Description
(package private) BiMap<K,V>	delegate()
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<V>	values()

Methods inherited from class com.google.common.collect.Synchronized.SynchronizedMap

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size

Methods inherited from class com.google.common.collect.Synchronized.SynchronizedObject

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.common.collect.BiMap

put, putAll

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size

Field Detail

valueSet

@CheckForNull
private transient java.util.Set<V> valueSet

inverse

@CheckForNull
private transient BiMap<V,K> inverse

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

SynchronizedBiMap

private SynchronizedBiMap(BiMap<K,V> delegate,
                          @CheckForNull
                          java.lang.Object mutex,
                          @CheckForNull
                          BiMap<V,K> inverse)

Method Detail

delegate

BiMap<K,V> delegate()

Overrides:

delegate in class Synchronized.SynchronizedMap<K,V>

values

public java.util.Set<V> values()

Description copied from interface: BiMap

Because a bimap has unique values, this method returns a Set, instead of the Collection specified in the Map interface.

Specified by:

values in interface BiMap<K,V>

Specified by:

values in interface java.util.Map<K,V>

Overrides:

values in class Synchronized.SynchronizedMap<K,V>

forcePut

@CheckForNull
public V forcePut(K key,
                  V value)

Description copied from interface: BiMap

An alternate form of 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.

Specified by:

forcePut in interface BiMap<K,V>

Parameters:

key - the key with which the specified value is to be associated

value - the value to be associated with the specified key

Returns:

the value that was previously associated with the key, or null if there was no previous entry. (If the bimap contains null values, then forcePut, like put, returns null both if the key is absent and if it is present with a null value.)

inverse

public BiMap<V,K> inverse()

Description copied from interface: BiMap

Returns 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.

Specified by:

inverse in interface BiMap<K,V>

Returns:

the inverse view of this bimap