com.google.common.collect

Class RegularImmutableBiMap<K,V>

java.lang.Object

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

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

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

All Implemented Interfaces:

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

@GwtCompatible(serializable=true,
               emulated=true)
class RegularImmutableBiMap<K,V>
extends ImmutableBiMap<K,V>

Bimap with two or more mappings.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	RegularImmutableBiMap.Inverse
private static class	RegularImmutableBiMap.InverseSerializedForm<K,V>
private static class	RegularImmutableBiMap.NonTerminalBiMapEntry<K,V>

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

ImmutableBiMap.Builder<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 ImmutableMapEntry<K,V>[]	entries
private int	hashCode
private ImmutableBiMap<V,K>	inverse
private ImmutableMapEntry<K,V>[]	keyTable
private int	mask
(package private) static double	MAX_LOAD_FACTOR
private ImmutableMapEntry<K,V>[]	valueTable

Constructor Summary

Constructors

Constructor and Description
RegularImmutableBiMap(ImmutableMapEntry.TerminalEntry<?,?>... entriesToAdd)
RegularImmutableBiMap(int n, ImmutableMapEntry.TerminalEntry<?,?>[] entriesToAdd) Constructor for RegularImmutableBiMap that takes as input an array of TerminalEntry entries.
RegularImmutableBiMap(java.util.Map.Entry<?,?>[] entriesToAdd) Constructor for RegularImmutableBiMap that makes no assumptions about the input entries.

Method Summary

Modifier and Type	Method and Description
private static <K,V> ImmutableMapEntry<K,V>[]	createEntryArray(int length)
(package private) ImmutableSet<java.util.Map.Entry<K,V>>	createEntrySet()
V	get(java.lang.Object key)
ImmutableBiMap<V,K>	inverse() Returns the inverse view of this bimap, which maps each of this bimap's values to its associated key.
(package private) boolean	isPartialView()
int	size()

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

builder, copyOf, forcePut, of, of, of, of, of, of, values, writeReplace

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

asMultimap, checkNoConflict, clear, containsKey, containsValue, createKeySet, entryOf, entrySet, equals, hashCode, isEmpty, keySet, put, putAll, remove, 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, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll

Field Detail

MAX_LOAD_FACTOR

static final double MAX_LOAD_FACTOR

See Also:

Constant Field Values

keyTable

private final transient ImmutableMapEntry<K,V>[] keyTable

valueTable

private final transient ImmutableMapEntry<K,V>[] valueTable

entries

private final transient ImmutableMapEntry<K,V>[] entries

mask

private final transient int mask

hashCode

private final transient int hashCode

inverse

private transient ImmutableBiMap<V,K> inverse

Constructor Detail

RegularImmutableBiMap

RegularImmutableBiMap(ImmutableMapEntry.TerminalEntry<?,?>... entriesToAdd)

RegularImmutableBiMap

RegularImmutableBiMap(int n,
                      ImmutableMapEntry.TerminalEntry<?,?>[] entriesToAdd)

Constructor for RegularImmutableBiMap that takes as input an array of TerminalEntry entries. Assumes that these entries have already been checked for null.

This allows reuse of the entry objects from the array in the actual implementation.

RegularImmutableBiMap

RegularImmutableBiMap(java.util.Map.Entry<?,?>[] entriesToAdd)

Constructor for RegularImmutableBiMap that makes no assumptions about the input entries.

Method Detail

createEntryArray

private static <K,V> ImmutableMapEntry<K,V>[] createEntryArray(int length)

get

@Nullable
public V get(@Nullable
                       java.lang.Object key)

Specified by:

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

Specified by:

get in class ImmutableMap<K,V>

createEntrySet

ImmutableSet<java.util.Map.Entry<K,V>> createEntrySet()

Specified by:

createEntrySet in class ImmutableMap<K,V>

isPartialView

boolean isPartialView()

Specified by:

isPartialView in class ImmutableMap<K,V>

size

public int size()

inverse

public ImmutableBiMap<V,K> inverse()

Description copied from class: ImmutableBiMap

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.

The inverse of an ImmutableBiMap is another ImmutableBiMap.

Specified by:

inverse in interface BiMap<K,V>

Specified by:

inverse in class ImmutableBiMap<K,V>

Returns:

the inverse view of this bimap