Package com.google.common.collect

Class Maps.UnmodifiableBiMap<K,V>

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.collect.ForwardingMap<K,V>

com.google.common.collect.Maps.UnmodifiableBiMap<K,V>

All Implemented Interfaces:

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

Enclosing class:

Maps

private static class Maps.UnmodifiableBiMap<K,V>
extends ForwardingMap<K,V>
implements BiMap<K,V>, java.io.Serializable

See Also:

Maps.unmodifiableBiMap(BiMap)

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.collect.ForwardingMap

ForwardingMap.StandardEntrySet, ForwardingMap.StandardKeySet, ForwardingMap.StandardValues

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
(package private) BiMap<? extends K,? extends V>	delegate
(package private) BiMap<V,K>	inverse
private static long	serialVersionUID
(package private) java.util.Map<K,V>	unmodifiableMap
(package private) java.util.Set<V>	values

Constructor Summary

Constructors

Constructor	Description
UnmodifiableBiMap(BiMap<? extends K,? extends V> delegate, BiMap<V,K> inverse)

Method Summary

Modifier and Type	Method	Description
protected java.util.Map<K,V>	delegate()	Returns the backing delegate instance that methods are forwarded to.
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.ForwardingMap

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, standardClear, standardContainsKey, standardContainsValue, standardEquals, standardHashCode, standardIsEmpty, standardPutAll, standardRemove, standardToString

Methods inherited from class com.google.common.collect.ForwardingObject

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

unmodifiableMap

final java.util.Map<K,V> unmodifiableMap

delegate

final BiMap<? extends K,? extends V> delegate

inverse

BiMap<V,K> inverse

values

transient java.util.Set<V> values

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

UnmodifiableBiMap

UnmodifiableBiMap(BiMap<? extends K,? extends V> delegate,
                  BiMap<V,K> inverse)

Method Detail

delegate

protected java.util.Map<K,V> delegate()

Description copied from class: ForwardingObject

Returns 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 as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.

Specified by:

delegate in class ForwardingMap<K,V>

forcePut

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 which was previously associated with the key, which may be null, or null if there was no previous entry

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

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 ForwardingMap<K,V>