me.lucko.helper.messaging.util

Class MappedChannelReceiver<T,K,V>

java.lang.Object

me.lucko.helper.messaging.util.MappedChannelReceiver<T,K,V>

Type Parameters:

T - the message type

K - the key type

V - the value type

All Implemented Interfaces:

AutoCloseable, Terminable

public final class MappedChannelReceiver<T,K,V>
extends Object
implements Terminable

Creates a subscription to a channel, and maps received values to a calculated key.

Field Summary

Fields inherited from interface me.lucko.helper.terminable.Terminable

EMPTY

Method Summary

Modifier and Type	Method and Description
Map<K,V>	asMap() Returns a map of the received data.
void	close() Closes this resource.
static <T,K,V> MappedChannelReceiver<T,K,V>	create(Channel<T> channel, Function<? super T,? extends K> keyMapper, Function<? super T,? extends V> valueMapper, Map<K,V> map) Creates a new mapped channel receiver.
static <T,K> MappedChannelReceiver<T,K,T>	create(Channel<T> channel, Function<? super T,? extends K> keyMapper, Map<K,T> map) Creates a new mapped channel receiver.
static <T,K,V> MappedChannelReceiver<T,K,V>	createExpiring(Channel<T> channel, Function<? super T,? extends K> keyMapper, Function<? super T,? extends V> valueMapper, long expiryDuration, TimeUnit unit) Creates a new expiring mapped channel receiver.
static <T,K> MappedChannelReceiver<T,K,T>	createExpiring(Channel<T> channel, Function<? super T,? extends K> keyMapper, long expiryDuration, TimeUnit unit) Creates a new expiring mapped channel receiver.
V	getValue(K key) Gets a value from the backing data
void	invalidateEntry(K key) Invalidates a specific entry in the backing data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface me.lucko.helper.terminable.Terminable

bindWith, closeAndReportException, closeSilently, isClosed

Method Detail

createExpiring

@Nonnull
public static <T,K,V> MappedChannelReceiver<T,K,V> createExpiring(@Nonnull
                                                                           Channel<T> channel,
                                                                           @Nonnull
                                                                           Function<? super T,? extends K> keyMapper,
                                                                           @Nonnull
                                                                           Function<? super T,? extends V> valueMapper,
                                                                           long expiryDuration,
                                                                           @Nonnull
                                                                           TimeUnit unit)

Creates a new expiring mapped channel receiver.

Type Parameters:

T - the message type

K - the key type

V - the value type

Parameters:

channel - the channel

keyMapper - the function used to map keys

valueMapper - the function used to map values

expiryDuration - the duration to expire entries after

unit - the unit of the duration

Returns:

a new mapped channel receiver

createExpiring

@Nonnull
public static <T,K> MappedChannelReceiver<T,K,T> createExpiring(@Nonnull
                                                                         Channel<T> channel,
                                                                         @Nonnull
                                                                         Function<? super T,? extends K> keyMapper,
                                                                         long expiryDuration,
                                                                         @Nonnull
                                                                         TimeUnit unit)

Creates a new expiring mapped channel receiver.

Type Parameters:

T - the message type

K - the key type

Parameters:

channel - the channel

keyMapper - the function used to map keys

expiryDuration - the duration to expire entries after

unit - the unit of the duration

Returns:

a new mapped channel receiver

create

@Nonnull
public static <T,K,V> MappedChannelReceiver<T,K,V> create(@Nonnull
                                                                   Channel<T> channel,
                                                                   @Nonnull
                                                                   Function<? super T,? extends K> keyMapper,
                                                                   @Nonnull
                                                                   Function<? super T,? extends V> valueMapper,
                                                                   Map<K,V> map)

Creates a new mapped channel receiver.

Type Parameters:

T - the message type

K - the key type

V - the value type

Parameters:

channel - the channel

keyMapper - the function used to map keys

valueMapper - the function used to map values

map - the map instance used to back the instance

Returns:

a new mapped channel receiver

create

@Nonnull
public static <T,K> MappedChannelReceiver<T,K,T> create(@Nonnull
                                                                 Channel<T> channel,
                                                                 @Nonnull
                                                                 Function<? super T,? extends K> keyMapper,
                                                                 Map<K,T> map)

Creates a new mapped channel receiver.

Type Parameters:

T - the message type

K - the key type

Parameters:

channel - the channel

keyMapper - the function used to map keys

map - the map instance used to back the instance

Returns:

a new mapped channel receiver

asMap

@Nonnull
public Map<K,V> asMap()

Returns a map of the received data.

Returns:

the data

getValue

@Nullable
public V getValue(@Nonnull
                            K key)

Gets a value from the backing data

Parameters:

key - the key

Returns:

the value, if present

invalidateEntry

public void invalidateEntry(@Nonnull
                            K key)

Invalidates a specific entry in the backing data.

Parameters:

key - the key

close

public void close()

Description copied from interface: Terminable

Closes this resource.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Terminable