com.github.tonivade.purefun.data

Interface ImmutableTreeMap<K,V>

All Superinterfaces:

ImmutableMap<K,V>

All Known Implementing Classes:

ImmutableTreeMap.JavaBasedImmutableTreeMap

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ImmutableTreeMap.Builder<K,V>
static class	ImmutableTreeMap.JavaBasedImmutableTreeMap<K,V>

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

ImmutableMap.JavaBasedImmutableMap<K,V>

Method Summary

Modifier and Type	Method and Description
static <K,V> ImmutableTreeMap.Builder<K,V>	builder()
Option<Tuple2<K,V>>	ceilingEntry(K key)
default Option<K>	ceilingKey(K key)
static <K,V> ImmutableTreeMap<K,V>	empty()
static <K,V> Tuple2<K,V>	entry(K key, V value)
default ImmutableTreeMap<K,V>	filterKeys(Matcher1<K> filter)
default ImmutableTreeMap<K,V>	filterValues(Matcher1<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(java.util.NavigableMap<K,V> map)
static <K,V> ImmutableTreeMap<K,V>	from(java.util.stream.Stream<Tuple2<K,V>> entries)
default V	getOrDefault(K key, Producer<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,B> ImmutableTreeMap<A,B>	map(Function1<K,A> keyMapper, Function1<V,B> valueMapper)
default <A> ImmutableTreeMap<A,V>	mapKeys(Function1<K,A> mapper)
default <A> ImmutableTreeMap<K,A>	mapValues(Function1<V,A> mapper)
ImmutableTreeMap<K,V>	merge(K key, V value, Operator2<V> merger)
static <K,V> ImmutableTreeMap<K,V>	of(Tuple2<K,V>... entries)
ImmutableTreeMap<K,V>	put(K key, V value)
ImmutableTreeMap<K,V>	putAll(ImmutableSet<Tuple2<K,V>> other)
default ImmutableTreeMap<K,V>	putIfAbsent(K key, V value)
ImmutableTreeMap<K,V>	remove(K key)
Option<Tuple2<K,V>>	tailEntry()
default Option<K>	tailKey()
ImmutableTreeMap<K,V>	tailMap(K fromKey)
java.util.NavigableMap<K,V>	toNavigableMap()

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

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

Method Detail

toNavigableMap

java.util.NavigableMap<K,V> toNavigableMap()

put

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

Specified by:

put in interface ImmutableMap<K,V>

putAll

ImmutableTreeMap<K,V> putAll(ImmutableSet<Tuple2<K,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>

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)

map

default <A,B> ImmutableTreeMap<A,B> map(Function1<K,A> keyMapper,
                                        Function1<V,B> valueMapper)

Specified by:

map in interface ImmutableMap<K,V>

mapKeys

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

Specified by:

mapKeys in interface ImmutableMap<K,V>

mapValues

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

Specified by:

mapValues in interface ImmutableMap<K,V>

filterKeys

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

Specified by:

filterKeys in interface ImmutableMap<K,V>

filterValues

default ImmutableTreeMap<K,V> filterValues(Matcher1<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<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)

Specified by:

of in interface ImmutableMap<K,V>

entry

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

Specified by:

entry in interface ImmutableMap<K,V>

from

static <K,V> ImmutableTreeMap<K,V> from(java.util.NavigableMap<K,V> map)

empty

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

Specified by:

empty in interface ImmutableMap<K,V>

from

static <K,V> ImmutableTreeMap<K,V> from(java.util.stream.Stream<Tuple2<K,V>> entries)

Specified by:

from in interface ImmutableMap<K,V>

from

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

Specified by:

from in interface ImmutableMap<K,V>

builder

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

Specified by:

builder in interface ImmutableMap<K,V>