software.chronicle.datagrid.collection

Interface KeyedVisitable<K,E>

All Known Subinterfaces:

MapView<K,V>

All Known Implementing Classes:

AuthorisedChronicleQueueView, ChronicleQueueView, RemoteMapView, VanillaAuthorisedMapView, VanillaMapView

public interface KeyedVisitable<K,E>

This interface defines a means of visiting a resource for retrieving derived values and replacing the state of the Asset.

This interface allows visiting any element of a keyed collection of resources

The default implementations are trivial, however further guarantees can be provided. e.g. a remote client may have the code executed on the server atomically.

Method Summary

Modifier and Type	Method and Description
default <T,R> R	applyToKey(K key, @NotNull net.openhft.chronicle.core.util.SerializableBiFunction<E,T,R> function, T argument) Apply a function which takes an argument.
default <R> R	applyToKey(K key, @NotNull net.openhft.chronicle.core.util.SerializableFunction<E,R> function) Apply a function to the visitable and return the result.
default <T> void	asyncUpdateKey(K key, @NotNull net.openhft.chronicle.core.util.SerializableBiFunction<E,T,E> updateFunction, T argument) Apply a function to visitable potentially asynchronously.
default void	asyncUpdateKey(K key, @NotNull net.openhft.chronicle.core.util.SerializableFunction<E,E> updateFunction) Apply a function to visitable potentially asynchronously.
E	get(K key)
void	set(K key, E element)
default <T,A,R> R	syncUpdateKey(K key, @NotNull net.openhft.chronicle.core.util.SerializableBiFunction<E,T,E> updateFunction, T updateArgument, @NotNull net.openhft.chronicle.core.util.SerializableBiFunction<E,A,R> returnFunction, A returnArgument) Apply a function to update the state of a visible, and apply a function to return a result object synchronously.
default <R> R	syncUpdateKey(K key, @NotNull net.openhft.chronicle.core.util.SerializableFunction<E,E> updateFunction, @NotNull net.openhft.chronicle.core.util.SerializableFunction<E,R> returnFunction) Apply a function to update the state of a visible, and apply a function to return a result object synchronously.

Method Detail

get

@Nullable
E get(K key)

Parameters:

key - to get within this collection.

Returns:

the current state of a visitable Asset

set

void set(K key,
         E element)

Parameters:

key - to set within this collection.

element - replace the current state of the visitable Asset

applyToKey

@Nullable
default <R> R applyToKey(K key,
                                   @NotNull
                                   @NotNull net.openhft.chronicle.core.util.SerializableFunction<E,R> function)

Apply a function to the visitable and return the result. This function is assumed to not change the value in any significant way.

Type Parameters:

R - data type to return.

Parameters:

key - to visit within this collection.

function - to apply e.g. call a getter

Returns:

the result of the code called.

asyncUpdateKey

default void asyncUpdateKey(K key,
                            @NotNull
                            @NotNull net.openhft.chronicle.core.util.SerializableFunction<E,E> updateFunction)

Apply a function to visitable potentially asynchronously. This function is assumed to replace the value and trigger and events or replicated changes.

Parameters:

key - to visit within this collection.

updateFunction - to update the state of the visibility.

syncUpdateKey

@Nullable
default <R> R syncUpdateKey(K key,
                                      @NotNull
                                      @NotNull net.openhft.chronicle.core.util.SerializableFunction<E,E> updateFunction,
                                      @NotNull
                                      @NotNull net.openhft.chronicle.core.util.SerializableFunction<E,R> returnFunction)

Apply a function to update the state of a visible, and apply a function to return a result object synchronously.

Type Parameters:

R - data type to return.

Parameters:

key - to update within this collection.

updateFunction - update to apply to the value.

returnFunction - derive an object to return

Returns:

the result of the code called.

applyToKey

@Nullable
default <T,R> R applyToKey(K key,
                                     @NotNull
                                     @NotNull net.openhft.chronicle.core.util.SerializableBiFunction<E,T,R> function,
                                     T argument)

Apply a function which takes an argument. This argument may contain a combination of data. This function is assumed to not change the value in any significant way.

Type Parameters:

T - type of the argument

R - type of the return value.

Parameters:

key - to visit within this collection.

function - to apply

argument - for the functions use.

Returns:

data derived.

asyncUpdateKey

default <T> void asyncUpdateKey(K key,
                                @NotNull
                                @NotNull net.openhft.chronicle.core.util.SerializableBiFunction<E,T,E> updateFunction,
                                T argument)

Apply a function to visitable potentially asynchronously. This argument may contain a combination of data. This function is assumed to replace the value and trigger and events or replicated changes.

Type Parameters:

T - type of the argument

Parameters:

key - to update within this collection

updateFunction - to update the state of the visitable.

argument - for the functions use.

syncUpdateKey

@Nullable
default <T,A,R> R syncUpdateKey(K key,
                                          @NotNull
                                          @NotNull net.openhft.chronicle.core.util.SerializableBiFunction<E,T,E> updateFunction,
                                          @Nullable
                                          T updateArgument,
                                          @NotNull
                                          @NotNull net.openhft.chronicle.core.util.SerializableBiFunction<E,A,R> returnFunction,
                                          @Nullable
                                          A returnArgument)

Apply a function to update the state of a visible, and apply a function to return a result object synchronously. This argument may contain a combination of data. Optionally the arguments could be null.

Type Parameters:

T - update argument type.

A - return argument type.

R - data type to return.

Parameters:

key - to update within this collection

updateFunction - update to apply to the value.

updateArgument - for the update function to use.

returnFunction - derive an object to return

returnArgument - for the return value function to use

Returns:

the result of the code called.