Package com.landawn.abacus.util

Class ImmutableMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

com.landawn.abacus.util.ImmutableMap<K,V>

Type Parameters:

K - the key type

V - the value type

All Implemented Interfaces:

Immutable, Map<K,V>

Direct Known Subclasses:

ImmutableBiMap, ImmutableSortedMap

@Immutable
public class ImmutableMap<K,V>
extends AbstractMap<K,V>
implements Immutable

Since:

0.8

Author:

Haiyang Li

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableMap.Builder<K,V>

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

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

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

Map.Entry<K extends Object,V extends Object>

Method Summary

Modifier and Type	Method	Description
static <K, V> ImmutableMap.Builder<K,V>	builder()
static <K, V> ImmutableMap.Builder<K,V>	builder(Map<K,V> backedMap)
final void	clear()	Deprecated. throws UnsupportedOperationException
final V	compute(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)	Deprecated. throws UnsupportedOperationException
final V	computeIfAbsent(K key, Function<? super K,? extends V> mappingFunction)	Deprecated. throws UnsupportedOperationException
final V	computeIfPresent(K key, BiFunction<? super K,? super V,? extends V> remappingFunction)	Deprecated. throws UnsupportedOperationException
boolean	containsKey(Object key)
boolean	containsValue(Object value)
static <K, V> ImmutableMap<K,V>	copyOf(Map<? extends K,? extends V> map)
static <K, V> ImmutableMap<K,V>	empty()
Set<Map.Entry<K,V>>	entrySet()
V	get(Object key)
V	getOrDefault(Object key, V defaultValue)	Gets the or default.
boolean	isEmpty()	Checks if is empty.
Set<K>	keySet()
final V	merge(K key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction)	Deprecated. throws UnsupportedOperationException
static <K, V> ImmutableMap<K,V>	of(Map<? extends K,? extends V> map)
static <K, V> ImmutableMap<K,V>	of(K k1, V v1)
static <K, V> ImmutableMap<K,V>	of(K k1, V v1, K k2, V v2)
static <K, V> ImmutableMap<K,V>	of(K k1, V v1, K k2, V v2, K k3, V v3)
static <K, V> ImmutableMap<K,V>	of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)
static <K, V> ImmutableMap<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> ImmutableMap<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> ImmutableMap<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)
final V	put(K k, V v)	Deprecated. throws UnsupportedOperationException
final void	putAll(Map<? extends K,? extends V> map)	Deprecated. throws UnsupportedOperationException
final V	putIfAbsent(K key, V value)	Deprecated. throws UnsupportedOperationException
final V	remove(Object o)	Deprecated. throws UnsupportedOperationException
final boolean	remove(Object key, Object value)	Deprecated. throws UnsupportedOperationException
final V	replace(K key, V value)	Deprecated. throws UnsupportedOperationException
final boolean	replace(K key, V oldValue, V newValue)	Deprecated. throws UnsupportedOperationException
int	size()
Collection<V>	values()

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

forEach, replaceAll

Method Details

empty

public static <K,
V> ImmutableMap<K,V> empty()

Type Parameters:

K - the key type

V - the value type

Returns:

of

public static <K,
V> ImmutableMap<K,V> of(K k1,
 V v1)

Type Parameters:

K - the key type

V - the value type

k -

v -

Parameters:

k1 -

v1 -

Returns:

of

public static <K,
V> ImmutableMap<K,V> of(K k1,
 V v1,
 K k2,
 V v2)

Type Parameters:

K - the key type

V - the value type

k -

v -

Parameters:

k1 -

v1 -

k2 -

v2 -

Returns:

of

public static <K,
V> ImmutableMap<K,V> of(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3)

Type Parameters:

K - the key type

V - the value type

k -

v -

Parameters:

k1 -

v1 -

k2 -

v2 -

k3 -

v3 -

Returns:

of

public static <K,
V> ImmutableMap<K,V> of(K k1,
 V v1,
 K k2,
 V v2,
 K k3,
 V v3,
 K k4,
 V v4)

Type Parameters:

K - the key type

V - the value type

k -

v -

Parameters:

k1 -

v1 -

k2 -

v2 -

k3 -

v3 -

k4 -

v4 -

Returns:

of

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

Type Parameters:

K - the key type

V - the value type

k -

v -

Parameters:

k1 -

v1 -

k2 -

v2 -

k3 -

v3 -

k4 -

v4 -

k5 -

v5 -

Returns:

of

public static <K,
V> ImmutableMap<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)

Type Parameters:

K - the key type

V - the value type

k -

v -

Parameters:

k1 -

v1 -

k2 -

v2 -

k3 -

v3 -

k4 -

v4 -

k5 -

v5 -

k6 -

v6 -

Returns:

of

public static <K,
V> ImmutableMap<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)

Type Parameters:

K - the key type

V - the value type

k -

v -

Parameters:

k1 -

v1 -

k2 -

v2 -

k3 -

v3 -

k4 -

v4 -

k5 -

v5 -

k6 -

v6 -

k7 -

v7 -

Returns:

of

public static <K,
V> ImmutableMap<K,V> of(Map<? extends K,? extends V> map)

Type Parameters:

K - the key type

V - the value type

Parameters:

map - the elements in this map are shared by the returned ImmutableMap.

Returns:

copyOf

public static <K,
V> ImmutableMap<K,V> copyOf(Map<? extends K,? extends V> map)

Type Parameters:

K - the key type

V - the value type

Parameters:

map -

Returns:

getOrDefault

public V getOrDefault(Object key,
 V defaultValue)

Gets the or default.

Specified by:

getOrDefault in interface Map<K,V>

Parameters:

key -

defaultValue -

Returns:

put

@Deprecated
public final V put(K k,
 V v)
            throws UnsupportedOperationException

Deprecated.

throws UnsupportedOperationException

Specified by:

put in interface Map<K,V>

Overrides:

put in class AbstractMap<K,V>

Parameters:

k -

v -

Returns:

Throws:

UnsupportedOperationException

remove

@Deprecated
public final V remove(Object o)
               throws UnsupportedOperationException

Deprecated.

throws UnsupportedOperationException

Specified by:

remove in interface Map<K,V>

Overrides:

remove in class AbstractMap<K,V>

Parameters:

o -

Returns:

Throws:

UnsupportedOperationException

putAll

@Deprecated
public final void putAll(Map<? extends K,? extends V> map)
                  throws UnsupportedOperationException

Deprecated.

throws UnsupportedOperationException

Specified by:

putAll in interface Map<K,V>

Overrides:

putAll in class AbstractMap<K,V>

Parameters:

map -

Throws:

UnsupportedOperationException

putIfAbsent

@Deprecated
public final V putIfAbsent(K key,
 V value)
                    throws UnsupportedOperationException

Deprecated.

throws UnsupportedOperationException

Put if absent.

Specified by:

putIfAbsent in interface Map<K,V>

Parameters:

key -

value -

Returns:

Throws:

UnsupportedOperationException

remove

@Deprecated
public final boolean remove(Object key,
 Object value)
                     throws UnsupportedOperationException

Deprecated.

throws UnsupportedOperationException

Specified by:

remove in interface Map<K,V>

Parameters:

key -

value -

Returns:

Throws:

UnsupportedOperationException

replace

@Deprecated
public final boolean replace(K key,
 V oldValue,
 V newValue)
                      throws UnsupportedOperationException

Deprecated.

throws UnsupportedOperationException

Specified by:

replace in interface Map<K,V>

Parameters:

key -

oldValue -

newValue -

Returns:

Throws:

UnsupportedOperationException

replace

@Deprecated
public final V replace(K key,
 V value)
                throws UnsupportedOperationException

Deprecated.

throws UnsupportedOperationException

Specified by:

replace in interface Map<K,V>

Parameters:

key -

value -

Returns:

Throws:

UnsupportedOperationException

computeIfAbsent

@Deprecated
public final V computeIfAbsent(K key,
 Function<? super K,? extends V> mappingFunction)
                        throws UnsupportedOperationException

Deprecated.

throws UnsupportedOperationException

Compute if absent.

Specified by:

computeIfAbsent in interface Map<K,V>

Parameters:

key -

mappingFunction -

Returns:

Throws:

UnsupportedOperationException

computeIfPresent

@Deprecated
public final V computeIfPresent(K key,
 BiFunction<? super K,? super V,? extends V> remappingFunction)
                         throws UnsupportedOperationException

Deprecated.

throws UnsupportedOperationException

Compute if present.

Specified by:

computeIfPresent in interface Map<K,V>

Parameters:

key -

remappingFunction -

Returns:

Throws:

UnsupportedOperationException

compute

@Deprecated
public final V compute(K key,
 BiFunction<? super K,? super V,? extends V> remappingFunction)
                throws UnsupportedOperationException

Deprecated.

throws UnsupportedOperationException

Specified by:

compute in interface Map<K,V>

Parameters:

key -

remappingFunction -

Returns:

Throws:

UnsupportedOperationException

merge

@Deprecated
public final V merge(K key,
 V value,
 BiFunction<? super V,? super V,? extends V> remappingFunction)
              throws UnsupportedOperationException

Deprecated.

throws UnsupportedOperationException

Specified by:

merge in interface Map<K,V>

Parameters:

key -

value -

remappingFunction -

Returns:

Throws:

UnsupportedOperationException

clear

@Deprecated
public final void clear()
                 throws UnsupportedOperationException

Deprecated.

throws UnsupportedOperationException

Specified by:

clear in interface Map<K,V>

Overrides:

clear in class AbstractMap<K,V>

Throws:

UnsupportedOperationException

isEmpty

public boolean isEmpty()

Checks if is empty.

Specified by:

isEmpty in interface Map<K,V>

Overrides:

isEmpty in class AbstractMap<K,V>

Returns:

true, if is empty

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

Overrides:

containsKey in class AbstractMap<K,V>

Parameters:

key -

Returns:

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

Overrides:

containsValue in class AbstractMap<K,V>

Parameters:

value -

Returns:

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

Overrides:

get in class AbstractMap<K,V>

Parameters:

key -

Returns:

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

Overrides:

keySet in class AbstractMap<K,V>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

Overrides:

values in class AbstractMap<K,V>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in class AbstractMap<K,V>

size

public int size()

Specified by:

size in interface Map<K,V>

Overrides:

size in class AbstractMap<K,V>

builder

public static <K,
V> ImmutableMap.Builder<K,V> builder()

builder

public static <K,
V> ImmutableMap.Builder<K,V> builder(Map<K,V> backedMap)