BiMap (abacus API Documentation)

java.lang.Object
- com.landawn.abacus.util.BiMap<K,V>

All Implemented Interfaces:

java.util.Map<K,V>
```
public final class BiMap<K,V>
extends java.lang.Object
implements java.util.Map<K,V>
```
A BiMap (or "bidirectional map") is a map that preserves the uniqueness of its values as well as that of its keys. This constraint enables BiMaps to support an "inverse view", which is another BiMap containing the same entries as this BiMap but with reversed keys and values.

Since:

0.8

Author:

Haiyang Li

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description
`BiMap()`
`BiMap(java.lang.Class<? extends java.util.Map> keyMapType, java.lang.Class<? extends java.util.Map> valueMapType)`
`BiMap(int initialCapacity)`
`BiMap(int initialCapacity, float loadFactor)`
`BiMap(Supplier<? extends java.util.Map<K,V>> keyMapSupplier, Supplier<? extends java.util.Map<V,K>> valueMapSupplier)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clear()`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`BiMap<K,V>`	`copy()`
`static <K,V> BiMap<K,V>`	`copyOf(java.util.Map<? extends K,? extends V> map)`
`java.util.Set<java.util.Map.Entry<K,V>>`	`entrySet()` Returns an immutable Set of Immutable entry.
`boolean`	`equals(java.lang.Object obj)`
`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 `put(K, V)` operation.
`static <K,V> BiMap<K,V>`	`from(java.util.Map<? extends K,? extends V> map)` Deprecated. replaced by `copyOf`
`V`	`get(java.lang.Object key)`
`K`	`getByValue(java.lang.Object value)`
`int`	`hashCode()`
`BiMap<V,K>`	`inversed()` Returns the inverse view of this BiMap, which maps each of this bimap's values to its associated key.
`boolean`	`isEmpty()`
`java.util.Set<K>`	`keySet()` Returns an immutable key set.
`static <K,V,k extends K,v extends V> BiMap<K,V>`	`of(k k1, v v1)`
`static <K,V,k extends K,v extends V> BiMap<K,V>`	`of(k k1, v v1, k k2, v v2)`
`static <K,V,k extends K,v extends V> BiMap<K,V>`	`of(k k1, v v1, k k2, v v2, k k3, v v3)`
`static <K,V,k extends K,v extends V> BiMap<K,V>`	`of(k k1, v v1, k k2, v v2, k k3, v v3, k k4, v v4)`
`static <K,V,k extends K,v extends V> BiMap<K,V>`	`of(k k1, v v1, k k2, v v2, k k3, v v3, k k4, v v4, k k5, v v5)`
`static <K,V,k extends K,v extends V> BiMap<K,V>`	`of(k k1, v v1, k k2, v v2, k k3, v v3, k k4, v v4, k k5, v v5, k k6, v v6)`
`static <K,V,k extends K,v extends V> BiMap<K,V>`	`of(k k1, v v1, k k2, v v2, k k3, v v3, k k4, v v4, k k5, v v5, k k6, v v6, k k7, v v7)`
`V`	`put(K key, V value)`
`void`	`putAll(java.util.Map<? extends K,? extends V> m)` Warning: the results of calling this method may vary depending on the iteration order of `map`.
`V`	`remove(java.lang.Object key)`
`K`	`removeByValue(java.lang.Object value)`
`int`	`size()`
`java.lang.String`	`toString()`
`java.util.Set<V>`	`values()` Returns an immutable value set.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

BiMap
```
public BiMap()
```

BiMap
```
public BiMap(int initialCapacity)
```

BiMap

public BiMap(int initialCapacity,
             float loadFactor)

BiMap

public BiMap(java.lang.Class<? extends java.util.Map> keyMapType,
             java.lang.Class<? extends java.util.Map> valueMapType)

BiMap

public BiMap(Supplier<? extends java.util.Map<K,V>> keyMapSupplier,
             Supplier<? extends java.util.Map<V,K>> valueMapSupplier)

Method Detail

of

public static <K,V,k extends K,v extends V> BiMap<K,V> of(k k1,
                                                          v v1)

of

public static <K,V,k extends K,v extends V> BiMap<K,V> of(k k1,
                                                          v v1,
                                                          k k2,
                                                          v v2)

of

public static <K,V,k extends K,v extends V> BiMap<K,V> of(k k1,
                                                          v v1,
                                                          k k2,
                                                          v v2,
                                                          k k3,
                                                          v v3)

of

public static <K,V,k extends K,v extends V> BiMap<K,V> of(k k1,
                                                          v v1,
                                                          k k2,
                                                          v v2,
                                                          k k3,
                                                          v v3,
                                                          k k4,
                                                          v v4)

of

public static <K,V,k extends K,v extends V> BiMap<K,V> of(k k1,
                                                          v v1,
                                                          k k2,
                                                          v v2,
                                                          k k3,
                                                          v v3,
                                                          k k4,
                                                          v v4,
                                                          k k5,
                                                          v v5)

of

public static <K,V,k extends K,v extends V> BiMap<K,V> of(k k1,
                                                          v v1,
                                                          k k2,
                                                          v v2,
                                                          k k3,
                                                          v v3,
                                                          k k4,
                                                          v v4,
                                                          k k5,
                                                          v v5,
                                                          k k6,
                                                          v v6)

of

public static <K,V,k extends K,v extends V> BiMap<K,V> of(k k1,
                                                          v v1,
                                                          k k2,
                                                          v v2,
                                                          k k3,
                                                          v v3,
                                                          k k4,
                                                          v v4,
                                                          k k5,
                                                          v v5,
                                                          k k6,
                                                          v v6,
                                                          k k7,
                                                          v v7)

copyOf

public static <K,V> BiMap<K,V> copyOf(java.util.Map<? extends K,? extends V> map)

from

@Deprecated
public static <K,V> BiMap<K,V> from(java.util.Map<? extends K,? extends V> map)

Deprecated. replaced by copyOf

Parameters:: map -
Returns:

get
```
public V get(java.lang.Object key)
```
Specified by:

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

getByValue

public K getByValue(java.lang.Object value)

put
```
public V put(K key,
             V value)
```
Specified by:

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

Throws:

java.lang.IllegalArgumentException - if the given value is already bound to a different key in this bimap. The bimap will remain unmodified in this event. To avoid this exception, call forcePut(K, V) instead.

forcePut
```
public 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 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.

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

putAll
```
public void putAll(java.util.Map<? extends K,? extends V> m)
```
Warning: the results of calling this method may vary depending on the iteration order of map.

Specified by:

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

Throws:

java.lang.IllegalArgumentException - if an attempt to put any entry fails. Note that some map entries may have been added to the bimap before the exception was thrown.

remove
```
public V remove(java.lang.Object key)
```
Specified by:

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

removeByValue

public K removeByValue(java.lang.Object value)

containsKey
```
public boolean containsKey(java.lang.Object key)
```
Specified by:

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

containsValue
```
public boolean containsValue(java.lang.Object value)
```
Specified by:

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

keySet
```
public java.util.Set<K> keySet()
```
Returns an immutable key set.

Specified by:

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

values
```
public java.util.Set<V> values()
```
Returns an immutable value set.

Specified by:

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

entrySet
```
public java.util.Set<java.util.Map.Entry<K,V>> entrySet()
```
Returns an immutable Set of Immutable entry.

Specified by:

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

inversed
```
public BiMap<V,K> inversed()
```
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.

Returns:

copy
```
public BiMap<K,V> copy()
```

clear
```
public void clear()
```
Specified by:

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

isEmpty
```
public boolean isEmpty()
```
Specified by:

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

size
```
public int size()
```
Specified by:

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

hashCode
```
public int hashCode()
```
Specified by:

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

Overrides:

hashCode in class java.lang.Object

equals
```
public boolean equals(java.lang.Object obj)
```
Specified by:

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

Overrides:

equals in class java.lang.Object

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

Class BiMap<K,V>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

BiMap

BiMap

BiMap

BiMap

BiMap

Method Detail

of

of

of

of

of

of

of

copyOf

from

get

getByValue

put

forcePut

putAll

remove

removeByValue

containsKey

containsValue

keySet

values

entrySet

inversed

copy

clear

isEmpty

size

hashCode

equals

toString