Module id.xfunction

Package id.xfunction.util

Class ImmutableMultiMap<K,V>

Object

ImmutableMultiMap<K,V>

All Implemented Interfaces:

Iterable<Map.Entry<K,List<V>>>

public class ImmutableMultiMap<K,V>
extends Object
implements Iterable<Map.Entry<K,List<V>>>

Map where each key may have multiple values assigned to it. All pairs are insertion-ordered.

Factory methods support multiple entries with same values, example:

 ImmutableMultiMap.of(1, "a", 2, "b", 1, "c")
 

Constructor Summary

Constructors

Constructor	Description
ImmutableMultiMap(ImmutableMultiMap<K,V> other)
ImmutableMultiMap(Iterable<Map.Entry<K,V>> entries)
ImmutableMultiMap(Map.Entry<K,V>... entries)

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(K key)
List<V>	get(K key)
Optional<V>	getFirstParameter(K key)
boolean	isEmpty()
Iterator<Map.Entry<K,List<V>>>	iterator()	Read only iterator
static <K1, V1> ImmutableMultiMap<K1,V1>	of()
static <K, V> ImmutableMultiMap<K,V>	of(K k1, V v1)
static <K, V> ImmutableMultiMap<K,V>	of(K k1, V v1, K k2, V v2)
static <K, V> ImmutableMultiMap<K,V>	of(K k1, V v1, K k2, V v2, K k3, V v3)
static <K, V> ImmutableMultiMap<K,V>	of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)
static <K, V> ImmutableMultiMap<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> ImmutableMultiMap<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> ImmutableMultiMap<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)
static <K, V> ImmutableMultiMap<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, K k8, V v8)
static <K, V> ImmutableMultiMap<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, K k8, V v8, K k9, V v9)
Stream<Map.Entry<K,List<V>>>	stream()
String	toJsonString()
Map<K,V>	toMap()
String	toString()
Stream<V>	values()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

ImmutableMultiMap

public ImmutableMultiMap(ImmutableMultiMap<K,V> other)

ImmutableMultiMap

public ImmutableMultiMap(Iterable<Map.Entry<K,V>> entries)

ImmutableMultiMap

public ImmutableMultiMap(Map.Entry<K,V>... entries)

Method Details

of

public static <K1,
V1> ImmutableMultiMap<K1,V1> of()

of

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

of

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

of

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

of

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

of

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

of

public static <K,
V> ImmutableMultiMap<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,
 K k8,
 V v8)

of

public static <K,
V> ImmutableMultiMap<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,
 K k8,
 V v8,
 K k9,
 V v9)

get

public List<V> get(K key)

containsKey

public boolean containsKey(K key)

toString

public String toString()

Overrides:

toString in class Object

toJsonString

public String toJsonString()

getFirstParameter

public Optional<V> getFirstParameter(K key)

isEmpty

public boolean isEmpty()

toMap

public Map<K,V> toMap()

Returns:

single value map with only first value included

values

public Stream<V> values()

stream

public Stream<Map.Entry<K,List<V>>> stream()

iterator

public Iterator<Map.Entry<K,List<V>>> iterator()

Read only iterator

Specified by:

iterator in interface Iterable<K>