net.imglib2.cache.util

Interface KeyBimap<S,T>

Type Parameters:

S - source type

T - target type

public interface KeyBimap<S,T>

A bidirectional map between key types S and T (source and target). This is used to create adapters exposing a T→V cache as a S→V cache.

The S→T mapping must be injective. If the S→T mapping is not bijective, getSource(Object) should return null for target keys with no corresponding source key.

Author:

Tobias Pietzsch

Method Summary

Modifier and Type	Method and Description
static <S,T> KeyBimap<S,T>	build(Function<S,T> soureToTarget, Function<T,S> targetToSource)
S	getSource(T target) Returns source key source key mapping to a given target key, or null if there is no such source key.
T	getTarget(S source) Returns target key for a given source key.

Method Detail

getTarget

T getTarget(S source)

Returns target key for a given source key.

Parameters:

source - source key

Returns:

the target key corresponding to source

getSource

S getSource(T target)

Returns source key source key mapping to a given target key, or null if there is no such source key.

Parameters:

target - target key

Returns:

the source key mapping to target, or null if there is no such source key.

build

static <S,T> KeyBimap<S,T> build(Function<S,T> soureToTarget,
                                 Function<T,S> targetToSource)