Class ImmutableMap<K,V>

java.lang.Object

software.amazon.awssdk.utils.ImmutableMap<K,V>

Type Parameters:

K - Class of the key for the map.

V - Class of the value for the map.

All Implemented Interfaces:

Map<K,V>

@SdkProtectedApi
public final class ImmutableMap<K,V>
extends Object
implements Map<K,V>

An immutable map that could be built by convenient constructors.

Example of using map Builder:

 {
     @code
     Map<String, AttibuteValue> item = new ImmutableMap.Builder<String, AttibuteValue>()
             .put("one", new AttibuteValue("1"))
             .put("two", new AttibuteValue("2"))
             .put("three", new AttibuteValue("3")).build();
 }
 

For small immutable maps (up to five entries), the ImmutableMapParamter.of() methods are preferred:

 
   Map<String, AttibuteValue> item =
       ImmutableMap
           .of("one", new AttributeValue("1"),
               "two", new AttributeValue("2"),
               "three", new AttributeValue("3"), 
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableMap.Builder<K,V>	A convenient builder for creating ImmutableMap instances.

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

Map.Entry<K,V>

Method Summary

Modifier and Type	Method	Description
static <K, V> ImmutableMap.Builder<K,V>	builder()	Returns a new MapParameterBuilder instance.
void	clear()	Unsupported methods
boolean	containsKey(Object key)	Inherited methods
boolean	containsValue(Object value)
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(Object o)
V	get(Object key)
int	hashCode()
boolean	isEmpty()
Set<K>	keySet()
static <K, V> ImmutableMap<K,V>	of(K k0, V v0)	Returns an ImmutableMap instance containing a single entry.
static <K, V> ImmutableMap<K,V>	of(K k0, V v0, K k1, V v1)	Returns an ImmutableMap instance containing two entries.
static <K, V> ImmutableMap<K,V>	of(K k0, V v0, K k1, V v1, K k2, V v2)	Returns an ImmutableMap instance containing three entries.
static <K, V> ImmutableMap<K,V>	of(K k0, V v0, K k1, V v1, K k2, V v2, K k3, V v3)	Returns an ImmutableMap instance containing four entries.
static <K, V> ImmutableMap<K,V>	of(K k0, V v0, K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)	Returns an ImmutableMap instance containing five entries.
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> map)
V	remove(Object key)
int	size()
String	toString()
Collection<V>	values()

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

Method Details

builder

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

Returns a new MapParameterBuilder instance.

of

public static <K,
V> ImmutableMap<K,V> of(K k0,
 V v0)

Returns an ImmutableMap instance containing a single entry.

Parameters:

k0 - Key of the single entry.

v0 - Value of the single entry.

of

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

Returns an ImmutableMap instance containing two entries.

Parameters:

k0 - Key of the first entry.

v0 - Value of the first entry.

k1 - Key of the second entry.

v1 - Value of the second entry.

of

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

Returns an ImmutableMap instance containing three entries.

Parameters:

k0 - Key of the first entry.

v0 - Value of the first entry.

k1 - Key of the second entry.

v1 - Value of the second entry.

k2 - Key of the third entry.

v2 - Value of the third entry.

of

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

Returns an ImmutableMap instance containing four entries.

Parameters:

k0 - Key of the first entry.

v0 - Value of the first entry.

k1 - Key of the second entry.

v1 - Value of the second entry.

k2 - Key of the third entry.

v2 - Value of the third entry.

k3 - Key of the fourth entry.

v3 - Value of the fourth entry.

of

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

Returns an ImmutableMap instance containing five entries.

Parameters:

k0 - Key of the first entry.

v0 - Value of the first entry.

k1 - Key of the second entry.

v1 - Value of the second entry.

k2 - Key of the third entry.

v2 - Value of the third entry.

k3 - Key of the fourth entry.

v3 - Value of the fourth entry.

k4 - Key of the fifth entry.

v4 - Value of the fifth entry.

containsKey

public boolean containsKey(Object key)

Inherited methods

Specified by:

containsKey in interface Map<K,V>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

entrySet

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

Specified by:

entrySet in interface Map<K,V>

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

size

public int size()

Specified by:

size in interface Map<K,V>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

clear

public void clear()

Unsupported methods

Specified by:

clear in interface Map<K,V>

put

public V put(K key,
 V value)

Specified by:

put in interface Map<K,V>

putAll

public void putAll(Map<? extends K,? extends V> map)

Specified by:

putAll in interface Map<K,V>

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object