com.google.common.collect

Class Maps.FilteredEntryBiMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

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

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

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

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

All Implemented Interfaces:

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

Enclosing class:

Maps

static final class Maps.FilteredEntryBiMap<K,V>
extends Maps.FilteredEntryMap<K,V>
implements BiMap<K,V>

Nested Class Summary

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

Maps.FilteredEntryMap.KeySet

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
private BiMap<V,K>	inverse

Fields inherited from class com.google.common.collect.Maps.FilteredEntryMap

filteredEntrySet

Fields inherited from class com.google.common.collect.Maps.AbstractFilteredMap

predicate, unfiltered

Constructor Summary

Constructors

Modifier	Constructor and Description
(package private)	FilteredEntryBiMap(BiMap<K,V> delegate, Predicate<? super java.util.Map.Entry<K,V>> predicate)
private	FilteredEntryBiMap(BiMap<K,V> delegate, Predicate<? super java.util.Map.Entry<K,V>> predicate, BiMap<V,K> inverse)

Method Summary

Modifier and Type	Method and Description
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.
private static <K,V> Predicate<java.util.Map.Entry<V,K>>	inversePredicate(Predicate<? super java.util.Map.Entry<K,V>> forwardPredicate)
(package private) BiMap<K,V>	unfiltered()
java.util.Set<V>	values()

Methods inherited from class com.google.common.collect.Maps.FilteredEntryMap

createEntrySet, createKeySet

Methods inherited from class com.google.common.collect.Maps.AbstractFilteredMap

apply, containsKey, createValues, get, isEmpty, put, putAll, remove

Methods inherited from class com.google.common.collect.Maps.ViewCachingAbstractMap

entrySet, keySet

Methods inherited from class java.util.AbstractMap

clear, clone, containsValue, equals, hashCode, size, toString

Methods inherited from class java.lang.Object

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

inverse

private final BiMap<V,K> inverse

Constructor Detail

FilteredEntryBiMap

FilteredEntryBiMap(BiMap<K,V> delegate,
                   Predicate<? super java.util.Map.Entry<K,V>> predicate)

FilteredEntryBiMap

private FilteredEntryBiMap(BiMap<K,V> delegate,
                           Predicate<? super java.util.Map.Entry<K,V>> predicate,
                           BiMap<V,K> inverse)

Method Detail

inversePredicate

private static <K,V> Predicate<java.util.Map.Entry<V,K>> inversePredicate(Predicate<? super java.util.Map.Entry<K,V>> forwardPredicate)

unfiltered

BiMap<K,V> unfiltered()

forcePut

public V forcePut(@Nullable
                  K key,
                  @Nullable
                  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 Maps.ViewCachingAbstractMap<K,V>