net.openhft.chronicle.engine.api

Interface Visitable<E>

All Known Subinterfaces:

Reference<E>

All Known Implementing Classes:

RemoteReference, VanillaReference

public interface Visitable<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 an individual resource.

The default implementations are trivial, however further guarentees 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	applyTo(net.openhft.chronicle.core.util.SerializableBiFunction<E,T,R> function, T argument) Apply a function which takes an argument.
default <R> R	applyTo(net.openhft.chronicle.core.util.SerializableFunction<E,R> function) Apply a function to the visitable and return the result.
default <T> void	asyncUpdate(net.openhft.chronicle.core.util.SerializableBiFunction<E,T,E> updateFunction, T argument) Apply a function to visitable potentially asynchronously.
default void	asyncUpdate(net.openhft.chronicle.core.util.SerializableFunction<E,E> updateFunction) Apply a function to visitable potentially asynchronously.
E	get()
void	set(E e)
default <UT,RT,R> R	syncUpdate(net.openhft.chronicle.core.util.SerializableBiFunction<E,UT,E> updateFunction, UT updateArgument, net.openhft.chronicle.core.util.SerializableBiFunction<E,RT,R> returnFunction, RT returnArgument) Apply a function to update the state of a visible, and apply a function to return a result object synchronously.
default <R> R	syncUpdate(net.openhft.chronicle.core.util.SerializableFunction<E,E> updateFunction, 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

E get()

Returns:

the current state of a visitable Asset

set

void set(E e)

Parameters:

e - replace the current state of the visitable Asset

applyTo

default <R> R applyTo(@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:

function - to apply e.g. call a getter

Returns:

the result of the code called.

asyncUpdate

default void asyncUpdate(@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 replciated changes.

Parameters:

updateFunction - to update the state of the visitiable.

syncUpdate

default <R> R syncUpdate(@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.

Type Parameters:

R - data type to return.

Parameters:

updateFunction - update to apply to the value.

returnFunction - derive an object to return

Returns:

the result of the code called.

applyTo

default <T,R> R applyTo(@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:

function - to apply

argument - for the functions use.

Returns:

data derived.

asyncUpdate

default <T> void asyncUpdate(@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 replciated changes.

Type Parameters:

T - type of the argument

Parameters:

updateFunction - to update the state of the visitiable.

argument - for the functions use.

syncUpdate

default <UT,RT,R> R syncUpdate(@NotNull
                               net.openhft.chronicle.core.util.SerializableBiFunction<E,UT,E> updateFunction,
                               @Nullable
                               UT updateArgument,
                               @NotNull
                               net.openhft.chronicle.core.util.SerializableBiFunction<E,RT,R> returnFunction,
                               @Nullable
                               RT 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:

R - data type to return.

Parameters:

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.