Package com.github.tonivade.purefun.data

Interface ImmutableTreeMap<K,V>

Type Parameters:

K - the type of keys maintained by this map

V - the type of mapped values

All Superinterfaces:

ImmutableMap<K,V>, Iterable<Tuple2<K,V>>

All Known Implementing Classes:

ImmutableTreeMap.PImmutableTreeMap

public interface ImmutableTreeMap<K,V>
extends ImmutableMap<K,V>

Similar to a TreeMap

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ImmutableTreeMap.Builder<K extends Comparable<?>,V>
static final class	ImmutableTreeMap.PImmutableTreeMap<K,V>

Nested classes/interfaces inherited from interface com.github.tonivade.purefun.data.ImmutableMap

ImmutableMap.PImmutableMap<K,V>

Method Summary

Modifier and Type	Method	Description
default <A, B> ImmutableTreeMap<A,B>	bimap(Function1<? super K,? extends A> keyMapper, Function1<? super V,? extends B> valueMapper)
default <A, B> ImmutableTreeMap<A,B>	bimap(Comparator<? super A> comparator, Function1<? super K,? extends A> keyMapper, Function1<? super V,? extends B> valueMapper)
static <K extends Comparable<?>, V> ImmutableTreeMap.Builder<K,V>	builder()
Option<Tuple2<K,V>>	ceilingEntry(K key)
default Option<K>	ceilingKey(K key)
Comparator<K>	comparator()
static <K, V> ImmutableTreeMap<K,V>	empty()
static <K, V> Tuple2<K,V>	entry(K key, V value)
default ImmutableTreeMap<K,V>	filterKeys(Matcher1<? super K> filter)
default ImmutableTreeMap<K,V>	filterValues(Matcher1<? super V> filter)
Option<Tuple2<K,V>>	floorEntry(K key)
default Option<K>	floorKey(K key)
static <K, V> ImmutableTreeMap<K,V>	from(ImmutableSet<Tuple2<K,V>> entries)
static <K, V> ImmutableTreeMap<K,V>	from(Comparator<? super K> comparator, ImmutableSet<Tuple2<K,V>> entries)
static <K, V> ImmutableTreeMap<K,V>	from(Comparator<? super K> comparator, Map<K,V> map)
static <K, V> ImmutableTreeMap<K,V>	from(Comparator<? super K> comparator, Set<Map.Entry<K,V>> entries)
static <K, V> ImmutableTreeMap<K,V>	from(Comparator<? super K> comparator, Stream<Tuple2<K,V>> entries)
static <K, V> ImmutableTreeMap<K,V>	from(Map<K,V> map)
static <K, V> ImmutableTreeMap<K,V>	from(Set<Map.Entry<K,V>> entries)
static <K, V> ImmutableTreeMap<K,V>	from(Stream<Tuple2<K,V>> entries)
default V	getOrDefault(K key, Producer<? extends V> supplier)
Option<Tuple2<K,V>>	headEntry()
default Option<K>	headKey()
ImmutableTreeMap<K,V>	headMap(K toKey)
Option<Tuple2<K,V>>	higherEntry(K key)
default Option<K>	higherKey(K key)
default boolean	isEmpty()
Option<Tuple2<K,V>>	lowerEntry(K key)
default Option<K>	lowerKey(K key)
default <A> ImmutableTreeMap<A,V>	mapKeys(Function1<? super K,? extends A> mapper)
default <A> ImmutableTreeMap<A,V>	mapKeys(Comparator<? super A> comparator, Function1<? super K,? extends A> mapper)
default <A> ImmutableTreeMap<K,A>	mapValues(Function1<? super V,? extends A> mapper)
ImmutableTreeMap<K,V>	merge(K key, V value, Operator2<V> merger)
private static <R> Comparator<R>	naturalOrder()
static <K, V> ImmutableTreeMap<K,V>	of(Tuple2<K,V>... entries)
ImmutableTreeMap<K,V>	put(K key, V value)
ImmutableTreeMap<K,V>	putAll(ImmutableMap<? extends K,? extends V> other)
default ImmutableTreeMap<K,V>	putIfAbsent(K key, V value)
ImmutableTreeMap<K,V>	remove(K key)
ImmutableTreeMap<K,V>	removeAll(Sequence<? extends K> keys)
Option<Tuple2<K,V>>	tailEntry()
default Option<K>	tailKey()
ImmutableTreeMap<K,V>	tailMap(K fromKey)
private static <V> V	throwingMerge(V a, V b)
static <T, K, V> Collector<T,?,ImmutableTreeMap<K,V>>	toImmutableTreeMap(Function1<? super T,? extends K> keyMapper, Function1<? super T,? extends V> valueMapper)
static <T, K, V> Collector<T,?,ImmutableTreeMap<K,V>>	toImmutableTreeMap(Comparator<? super K> comparator, Function1<? super T,? extends K> keyMapper, Function1<? super T,? extends V> valueMapper)
NavigableMap<K,V>	toNavigableMap()
default SequencedMap<K,V>	toSequencedMap()
default SortedMap<K,V>	toSortedMap()
private static <T, K, V> Collector<T,?,? extends TreeMap<K,V>>	toTreeMap(Comparator<? super K> comparator, Function1<? super T,? extends K> keyMapper, Function1<? super T,? extends V> valueMapper)

Methods inherited from interface com.github.tonivade.purefun.data.ImmutableMap

containsKey, entries, forEach, get, iterator, keys, size, toMap, values

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

comparator

Comparator<K> comparator()

toNavigableMap

NavigableMap<K,V> toNavigableMap()

toSequencedMap

default SequencedMap<K,V> toSequencedMap()

toSortedMap

default SortedMap<K,V> toSortedMap()

put

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

Specified by:

put in interface ImmutableMap<K,V>

putAll

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

Specified by:

putAll in interface ImmutableMap<K,V>

remove

ImmutableTreeMap<K,V> remove(K key)

Specified by:

remove in interface ImmutableMap<K,V>

removeAll

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

Specified by:

removeAll in interface ImmutableMap<K,V>

merge

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

Specified by:

merge in interface ImmutableMap<K,V>

headMap

ImmutableTreeMap<K,V> headMap(K toKey)

tailMap

ImmutableTreeMap<K,V> tailMap(K fromKey)

headEntry

Option<Tuple2<K,V>> headEntry()

tailEntry

Option<Tuple2<K,V>> tailEntry()

higherEntry

Option<Tuple2<K,V>> higherEntry(K key)

lowerEntry

Option<Tuple2<K,V>> lowerEntry(K key)

floorEntry

Option<Tuple2<K,V>> floorEntry(K key)

ceilingEntry

Option<Tuple2<K,V>> ceilingEntry(K key)

headKey

default Option<K> headKey()

tailKey

default Option<K> tailKey()

higherKey

default Option<K> higherKey(K key)

lowerKey

default Option<K> lowerKey(K key)

floorKey

default Option<K> floorKey(K key)

ceilingKey

default Option<K> ceilingKey(K key)

bimap

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

Specified by:

bimap in interface ImmutableMap<K,V>

bimap

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

mapKeys

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

Specified by:

mapKeys in interface ImmutableMap<K,V>

mapKeys

default <A> ImmutableTreeMap<A,V> mapKeys(Comparator<? super A> comparator,
 Function1<? super K,? extends A> mapper)

mapValues

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

Specified by:

mapValues in interface ImmutableMap<K,V>

filterKeys

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

Specified by:

filterKeys in interface ImmutableMap<K,V>

filterValues

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

Specified by:

filterValues in interface ImmutableMap<K,V>

putIfAbsent

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

Specified by:

putIfAbsent in interface ImmutableMap<K,V>

getOrDefault

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

Specified by:

getOrDefault in interface ImmutableMap<K,V>

isEmpty

default boolean isEmpty()

Specified by:

isEmpty in interface ImmutableMap<K,V>

of

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

entry

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

from

static <K,
V> ImmutableTreeMap<K,V> from(Comparator<? super K> comparator,
 Map<K,V> map)

from

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

empty

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

from

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

from

static <K,
V> ImmutableTreeMap<K,V> from(Comparator<? super K> comparator,
 Stream<Tuple2<K,V>> entries)

from

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

from

static <K,
V> ImmutableTreeMap<K,V> from(Comparator<? super K> comparator,
 ImmutableSet<Tuple2<K,V>> entries)

from

static <K,
V> ImmutableTreeMap<K,V> from(Set<Map.Entry<K,V>> entries)

from

static <K,
V> ImmutableTreeMap<K,V> from(Comparator<? super K> comparator,
 Set<Map.Entry<K,V>> entries)

toImmutableTreeMap

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

toImmutableTreeMap

static <T,
K,
V>
Collector<T,?,ImmutableTreeMap<K,V>> toImmutableTreeMap(Comparator<? super K> comparator,
 Function1<? super T,? extends K> keyMapper,
 Function1<? super T,? extends V> valueMapper)

builder

static <K extends Comparable<?>,
V>
ImmutableTreeMap.Builder<K,V> builder()

naturalOrder

private static <R> Comparator<R> naturalOrder()

toTreeMap

private static <T,
K,
V>
Collector<T,?,? extends TreeMap<K,V>> toTreeMap(Comparator<? super K> comparator,
 Function1<? super T,? extends K> keyMapper,
 Function1<? super T,? extends V> valueMapper)

throwingMerge

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