Package de.scravy.bedrock

Interface Mapping<From,To>

Type Parameters:

From - The type of the keys.

To - The type of the values.

All Superinterfaces:

ExtendedIterable<Pair<From,To>>, Function<From,To>, Function1<From,To>, HasLengthAtLeast, Iterable<Pair<From,To>>

All Known Implementing Classes:

ArrayMap, Mapping.EmptyMapping

public interface Mapping<From,To>
extends Function1<From,To>, ExtendedIterable<Pair<From,To>>

A Mapping from keys to values. A Mapping is very much like Map, but it precludes mutable operations.

Every mapping is a function from keys to values that does know about the keys it maps. Hence a minimal complete definition of a Mapping consists of get(Object) and keys().

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Mapping.EmptyMapping<K,V>

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

ExtendedIterable.ForEachWithIndexConsumer<T>

Method Summary

Modifier and Type	Method	Description
default To	apply(From key)
static <K, V> Mapping<K,V>	empty()
default void	forEach(BiConsumer<? super From,? super To> action)
Optional<To>	get(From key)	Retrieves the value associated with the given key or Optional.empty() if the key is not mapped to any value.
default To	getOrElse(From key, To fallback)
default To	getOrNull(From key)
default boolean	isEmpty()
default Iterator<Pair<From,To>>	iterator()
Seq<From>	keys()
default int	size()
default Stream<Pair<From,To>>	stream()
default Map<From,To>	toMap()
default Seq<To>	values()
static <From, To> Mapping<From,To>	wrap(Map<From,To> map)

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

Method Details

get

@Nonnull Optional<To> get(From key)

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

Parameters:

key - The key.

Returns:

The value which the given key is mapped to.

keys

Seq<From> keys()

getOrElse

default To getOrElse(From key, To fallback)

getOrNull

@Nullable default To getOrNull(From key)

apply

default To apply(From key)

Specified by:

apply in interface Function<From,To>

Specified by:

apply in interface Function1<From,To>

size

default int size()

isEmpty

default boolean isEmpty()

values

default Seq<To> values()

iterator

@Nonnull default Iterator<Pair<From,To>> iterator()

Specified by:

iterator in interface Iterable<From>

stream

default Stream<Pair<From,To>> stream()

toMap

default Map<From,To> toMap()

forEach

default void forEach(BiConsumer<? super From,? super To> action)

wrap

static <From, To> Mapping<From,To> wrap(Map<From,To> map)

empty

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