net.kuujo.copycat.atomic

Interface AsyncReferenceProxy<T>

All Known Subinterfaces:

AsyncReference<T>

All Known Implementing Classes:

DefaultAsyncReference

public interface AsyncReferenceProxy<T>

Asynchronous atomic reference proxy.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	compareAndSet(T expect, T update) Sets the value if the current value == the expected value.
CompletableFuture<T>	get() Gets the value.
CompletableFuture<T>	getAndSet(T value) Sets and gets the value.
CompletableFuture<Void>	set(T value) Sets the value.

Method Detail

get

CompletableFuture<T> get()

Gets the value.

Returns:

A completable future to be completed with the current reference value.

set

CompletableFuture<Void> set(T value)

Sets the value.

Parameters:

value - The value to set.

Returns:

A completable future to be completed once the value has been set.

getAndSet

CompletableFuture<T> getAndSet(T value)

Sets and gets the value.

Parameters:

value - The new value to set.

Returns:

A completable future to be completed with the previous value.

compareAndSet

CompletableFuture<Boolean> compareAndSet(T expect,
                                         T update)

Sets the value if the current value == the expected value.

Parameters:

expect - The expected value.

update - The updated value.

Returns:

A completable future to be completed once the operation is complete with a boolean indicating whether the updated value was set.