net.kuujo.copycat.atomic

Interface AsyncBooleanProxy

All Known Subinterfaces:

AsyncBoolean

All Known Implementing Classes:

DefaultAsyncBoolean

public interface AsyncBooleanProxy

Asynchronous atomic boolean proxy.

Author:

Jordan Halterman

Method Summary

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

Method Detail

get

CompletableFuture<Boolean> get()

Gets the current value.

Returns:

A completable future to be completed with the current value.

set

CompletableFuture<Void> set(boolean value)

Sets the current value.

Parameters:

value - The current value.

Returns:

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

getAndSet

CompletableFuture<Boolean> getAndSet(boolean value)

Gets the current value and updates it.

Parameters:

value - The updated value.

Returns:

A completable future to be completed with the previous value.

compareAndSet

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

Compares the current value and updated it if expected value == the current value.

Parameters:

expect - The expected value.

update - The updated value.

Returns:

A completable future to be completed with a boolean value indicating whether the value was updated.