Package de.scravy.bedrock

Class ArrayMap<K extends Comparable<? super K>,V>

java.lang.Object

de.scravy.bedrock.ArrayMap<K,V>

Type Parameters:

K - The type of the keys of this ArrayMap. Must implement Comparable. Does not allow for null values.

V - The type of the values of this ArrayMap. Can be anything. Allows for null values.

All Implemented Interfaces:

ExtendedIterable<Pair<K,V>>, Function1<K,V>, HasLengthAtLeast, Mapping<K,V>, Iterable<Pair<K,V>>, Function<K,V>

@Immutable
public final class ArrayMap<K extends Comparable<? super K>,V>
extends Object
implements Mapping<K,V>

A very simple immutable map that is backed by two arrays (one for the keys, one for the values). Lookups are performed by performing binary searches on the key array - thus the keys need to implement the Comparable interface.

Some operations are implemented quite space efficiently. For instance both mapValues and mapValuesWithKey share the key array with the source ArrayMap.

Nested Class Summary

Nested classes/interfaces inherited from interface de.scravy.bedrock.ExtendedIterable

ExtendedIterable.ForEachWithIndexConsumer<T>

Nested classes/interfaces inherited from interface de.scravy.bedrock.Mapping

Mapping.EmptyMapping<K,V>

Constructor Summary

Constructors

Constructor	Description
ArrayMap()

Method Summary

Modifier and Type	Method	Description
V	apply(K key)
static <K extends Comparable<? super K>, V> ArrayMapBuilder<K,V>	builder()
static <K extends Comparable<? super K>, V> Collector<Pair<K,V>,TreeMap<K,V>,ArrayMap<K,V>>	collector()
static <K extends Comparable<? super K>, V> ArrayMap<K,V>	empty()
boolean	equals(Object other)
ArrayMap<K,V>	filter(Predicate<K> predicate)
ArrayMap<K,V>	filterWithValue(BiPredicate<K,V> predicate)
Optional<V>	get(K key)	Retrieves the value associated with the given key or Optional.empty() if the key is not mapped to any value.
int	hashCode()
ArrayMap<K,V>	intersect(ArrayMap<K,V> arrayMap)
Iterator<Pair<K,V>>	iterator()
Seq<K>	keys()
<W> ArrayMap<K,W>	mapValues(Function<V,W> f)
<W> ArrayMap<K,W>	mapValuesWithKey(BiFunction<K,V,W> f)
static <K extends Comparable<K>, V> ArrayMap<K,V>	of(Pair<K,V>... pairs)
static <K extends Comparable<? super K>, V> ArrayMap<K,V>	ofMap(Map<K,V> pairs)
static <K extends Comparable<K>, V> ArrayMap<K,V>	ofSeq(Seq<Pair<K,V>> pairs)
static <K extends Comparable<? super K>, V> ArrayMap<K,V>	ofTreeMap(TreeMap<K,V> pairs)
ArrayMap<K,V>	setDefaultReturnValue(V value)
String	toString()
ArrayMap<K,V>	union(ArrayMap<K,V> arrayMap)
Seq<V>	values()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.scravy.bedrock.ExtendedIterable

forEachWithIndex, lengthAtLeast

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface de.scravy.bedrock.Function1

bind

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface de.scravy.bedrock.Mapping

forEach, getOrElse, getOrNull, isEmpty, size, stream, toMap

Constructor Details

ArrayMap

public ArrayMap()

Method Details

setDefaultReturnValue

public ArrayMap<K,V> setDefaultReturnValue(@Nullable V value)

get

@Nonnull public Optional<V> get(@Nonnull K key)

Description copied from interface: Mapping

Retrieves the value associated with the given key or Optional.empty() if the key is not mapped to any value.

Specified by:

get in interface Mapping<K extends Comparable<? super K>,V>

Parameters:

key - The key.

Returns:

The value which the given key is mapped to.

apply

public V apply(K key)

Specified by:

apply in interface Function<K extends Comparable<? super K>,V>

Specified by:

apply in interface Function1<K extends Comparable<? super K>,V>

Specified by:

apply in interface Mapping<K extends Comparable<? super K>,V>

mapValues

@Nonnull public <W> ArrayMap<K,W> mapValues(@Nonnull Function<V,W> f)

mapValuesWithKey

@Nonnull public <W> ArrayMap<K,W> mapValuesWithKey(@Nonnull BiFunction<K,V,W> f)

filter

@Nonnull public ArrayMap<K,V> filter(Predicate<K> predicate)

filterWithValue

@Nonnull public ArrayMap<K,V> filterWithValue(BiPredicate<K,V> predicate)

iterator

@Nonnull public Iterator<Pair<K,V>> iterator()

Specified by:

iterator in interface Iterable<K extends Comparable<? super K>>

Specified by:

iterator in interface Mapping<K extends Comparable<? super K>,V>

keys

@Nonnull public Seq<K> keys()

Specified by:

keys in interface Mapping<K extends Comparable<? super K>,V>

values

@Nonnull public Seq<V> values()

Specified by:

values in interface Mapping<K extends Comparable<? super K>,V>

union

@Nonnull public ArrayMap<K,V> union(@Nonnull ArrayMap<K,V> arrayMap)

intersect

@Nonnull public ArrayMap<K,V> intersect(@Nonnull ArrayMap<K,V> arrayMap)

toString

public String toString()

Overrides:

toString in class Object

of

@Nonnull @SafeVarargs public static <K extends Comparable<K>, V> ArrayMap<K,V> of(@Nonnull Pair<K,V>... pairs)

ofSeq

@Nonnull public static <K extends Comparable<K>, V> ArrayMap<K,V> ofSeq(@Nonnull Seq<Pair<K,V>> pairs)

ofMap

@Nonnull public static <K extends Comparable<? super K>, V> ArrayMap<K,V> ofMap(@Nonnull Map<K,V> pairs)

ofTreeMap

@Nonnull public static <K extends Comparable<? super K>, V> ArrayMap<K,V> ofTreeMap(@Nonnull TreeMap<K,V> pairs)

empty

@Nonnull public static <K extends Comparable<? super K>, V> ArrayMap<K,V> empty()

collector

@Nonnull public static <K extends Comparable<? super K>, V> Collector<Pair<K,V>,TreeMap<K,V>,ArrayMap<K,V>> collector()

builder

@Nonnull public static <K extends Comparable<? super K>, V> ArrayMapBuilder<K,V> builder()

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object