Package com.github.tonivade.purefun.data

Interface ImmutableMap<K,V>

Type Parameters:

K - the type of keys maintained by this map

V - the type of mapped values

All Superinterfaces:

Iterable<Tuple2<K,V>>

All Known Subinterfaces:

ImmutableTreeMap<K,V>

All Known Implementing Classes:

ImmutableMap.PImmutableMap, ImmutableTreeMap.PImmutableTreeMap

public interface ImmutableMap<K,V>
extends Iterable<Tuple2<K,V>>

Similar to a HashMap

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ImmutableMap.Builder<K,V>
static final class	ImmutableMap.PImmutableMap<K,V>

Method Summary

Modifier and Type	Method	Description
default <A, B> ImmutableMap<A,B>	bimap(Function1<? super K,? extends A> keyMapper, Function1<? super V,? extends B> valueMapper)
static <K, V> ImmutableMap.Builder<K,V>	builder()
default boolean	containsKey(K key)
static <K, V> ImmutableMap<K,V>	empty()
ImmutableSet<Tuple2<K,V>>	entries()
static <K, V> Tuple2<K,V>	entry(K key, V value)
default ImmutableMap<K,V>	filterKeys(Matcher1<? super K> filter)
default ImmutableMap<K,V>	filterValues(Matcher1<? super V> filter)
default void	forEach(Consumer2<? super K,? super V> consumer)
static <K, V> ImmutableMap<K,V>	from(ImmutableSet<Tuple2<K,V>> entries)
static <K, V> ImmutableMap<K,V>	from(Iterable<Tuple2<K,V>> entries)
static <K, V> ImmutableMap<K,V>	from(Map<K,V> map)
static <K, V> ImmutableMap<K,V>	from(Set<? extends Map.Entry<K,V>> entries)
static <K, V> ImmutableMap<K,V>	from(Stream<Tuple2<K,V>> entries)
Option<V>	get(K key)
default V	getOrDefault(K key, Producer<? extends V> supplier)
default boolean	isEmpty()
default Iterator<Tuple2<K,V>>	iterator()
ImmutableSet<K>	keys()
default <A> ImmutableMap<A,V>	mapKeys(Function1<? super K,? extends A> mapper)
default <A> ImmutableMap<K,A>	mapValues(Function1<? super V,? extends A> mapper)
ImmutableMap<K,V>	merge(K key, V value, Operator2<V> merger)
static <K, V> ImmutableMap<K,V>	of(Tuple2<K,V>... entries)
ImmutableMap<K,V>	put(K key, V value)
ImmutableMap<K,V>	putAll(ImmutableMap<? extends K,? extends V> other)
default ImmutableMap<K,V>	putIfAbsent(K key, V value)
ImmutableMap<K,V>	remove(K key)
ImmutableMap<K,V>	removeAll(Sequence<? extends K> keys)
int	size()
private static <V> V	throwingMerge(V a, V b)
static <T, K, V> Collector<T,?,ImmutableMap<K,V>>	toImmutableMap(Function1<? super T,? extends K> keyMapper, Function1<? super T,? extends V> valueMapper)
private static <T, K, V> Collector<T,?,? extends LinkedHashMap<K,V>>	toLinkedHashMap(Function1<? super T,? extends K> keyMapper, Function1<? super T,? extends V> valueMapper)
Map<K,V>	toMap()
Sequence<V>	values()

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

toMap

Map<K,V> toMap()

put

ImmutableMap<K,V> put(K key,
 V value)

putAll

ImmutableMap<K,V> putAll(ImmutableMap<? extends K,? extends V> other)

remove

ImmutableMap<K,V> remove(K key)

removeAll

ImmutableMap<K,V> removeAll(Sequence<? extends K> keys)

get

Option<V> get(K key)

values

Sequence<V> values()

keys

ImmutableSet<K> keys()

entries

ImmutableSet<Tuple2<K,V>> entries()

merge

ImmutableMap<K,V> merge(K key,
 V value,
 Operator2<V> merger)

size

int size()

iterator

default Iterator<Tuple2<K,V>> iterator()

Specified by:

iterator in interface Iterable<K>

forEach

default void forEach(Consumer2<? super K,? super V> consumer)

bimap

default <A,
B> ImmutableMap<A,B> bimap(Function1<? super K,? extends A> keyMapper,
 Function1<? super V,? extends B> valueMapper)

mapKeys

default <A> ImmutableMap<A,V> mapKeys(Function1<? super K,? extends A> mapper)

mapValues

default <A> ImmutableMap<K,A> mapValues(Function1<? super V,? extends A> mapper)

filterKeys

default ImmutableMap<K,V> filterKeys(Matcher1<? super K> filter)

filterValues

default ImmutableMap<K,V> filterValues(Matcher1<? super V> filter)

containsKey

default boolean containsKey(K key)

putIfAbsent

default ImmutableMap<K,V> putIfAbsent(K key,
 V value)

getOrDefault

default V getOrDefault(K key,
 Producer<? extends V> supplier)

isEmpty

default boolean isEmpty()

of

@SafeVarargs
static <K,
V> ImmutableMap<K,V> of(Tuple2<K,V>... entries)

entry

static <K,
V> Tuple2<K,V> entry(K key,
 V value)

from

static <K,
V> ImmutableMap<K,V> from(Map<K,V> map)

empty

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

from

static <K,
V> ImmutableMap<K,V> from(Iterable<Tuple2<K,V>> entries)

from

static <K,
V> ImmutableMap<K,V> from(Stream<Tuple2<K,V>> entries)

from

static <K,
V> ImmutableMap<K,V> from(ImmutableSet<Tuple2<K,V>> entries)

from

static <K,
V> ImmutableMap<K,V> from(Set<? extends Map.Entry<K,V>> entries)

toImmutableMap

static <T,
K,
V> Collector<T,?,ImmutableMap<K,V>> toImmutableMap(Function1<? super T,? extends K> keyMapper,
 Function1<? super T,? extends V> valueMapper)

builder

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

toLinkedHashMap

private static <T,
K,
V>
Collector<T,?,? extends LinkedHashMap<K,V>> toLinkedHashMap(Function1<? super T,? extends K> keyMapper,
 Function1<? super T,? extends V> valueMapper)

throwingMerge

private static <V> V throwingMerge(V a,
 V b)