Package com.terracottatech.store.async

Interface Operation<T>

Type Parameters:

T - the type of the operation result

All Superinterfaces:

CompletionStage<T>, Future<T>

public interface Operation<T>
extends Future<T>, CompletionStage<T>

A representation of the asynchronous execution of an operation. Asynchronous dataset operations can be incorporated as stages of a larger computation through use of the CompletionStage methods.

Method Summary

Modifier and Type	Method	Description
default Operation<Void>	acceptEither(CompletionStage<? extends T> other, Consumer<? super T> action)
default Operation<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action)
default Operation<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)
default <U> Operation<U>	applyToEither(CompletionStage<? extends T> other, Function<? super T,U> fn)
default <U> Operation<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn)
default <U> Operation<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn, Executor executor)
default Operation<T>	exceptionally(Function<Throwable,? extends T> fn)
default Executor	executor()	Returns the default asynchronous execution pool for this operation.
default <U> Operation<U>	handle(BiFunction<? super T,Throwable,? extends U> fn)
default <U> Operation<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> fn)
default <U> Operation<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> fn, Executor executor)
<U> Operation<U>	map(Function<? super T,? extends U> fn)	Returns a new Operation that represents the synchronous mapping of this stages result using the provided function.
static <T> Operation<T>	operation(CompletableFuture<T> future)	Create an operation who's completion is tied to the given CompletableFuture.
static <T> Operation<T>	operation(CompletableFuture<T> future, Executor executor)	/** Create an operation who's completion is tied to the given CompletableFuture.
static <T> Operation<T>	operation(Future<T> future)	Create an operation who's completion is tied to the given Future.
static <T> Operation<T>	operation(Future<T> future, Executor executor)	Create an operation who's completion is tied to the given Future.
default Operation<Void>	runAfterBoth(CompletionStage<?> other, Runnable action)
default Operation<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action)
default Operation<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action, Executor executor)
default Operation<Void>	runAfterEither(CompletionStage<?> other, Runnable action)
default Operation<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action)
default Operation<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action, Executor executor)
default Operation<Void>	thenAccept(Consumer<? super T> action)
default Operation<Void>	thenAcceptAsync(Consumer<? super T> action)
default Operation<Void>	thenAcceptAsync(Consumer<? super T> action, Executor executor)
default <U> Operation<Void>	thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
default <U> Operation<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
default <U> Operation<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action, Executor executor)
default <U> Operation<U>	thenApply(Function<? super T,? extends U> fn)
default <U> Operation<U>	thenApplyAsync(Function<? super T,? extends U> fn)
default <U> Operation<U>	thenApplyAsync(Function<? super T,? extends U> fn, Executor executor)
default <U, V> Operation<V>	thenCombine(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
default <U, V> Operation<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
default <U, V> Operation<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn, Executor executor)
default <U> Operation<U>	thenCompose(Function<? super T,? extends CompletionStage<U>> fn)
default <U> Operation<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn)
default <U> Operation<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn, Executor executor)
default Operation<Void>	thenRun(Runnable action)
default Operation<Void>	thenRunAsync(Runnable action)
default Operation<Void>	thenRunAsync(Runnable action, Executor executor)
default CompletableFuture<T>	toCompletableFuture()
CompletableFuture<T>	toCompletableFuture(Executor executor)	Returns a CompletableFuture maintaining the same completion properties as this stage using the supplied executor for any necessary synchronous calls.
default Operation<T>	usingExecutor(Executor executor)	Returns a new Operation that uses the supplied executor as it's default async executor.
default Operation<T>	whenComplete(BiConsumer<? super T,? super Throwable> action)
default Operation<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> action)
default Operation<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> action, Executor executor)

Methods inherited from interface java.util.concurrent.CompletionStage

exceptionallyAsync, exceptionallyAsync, exceptionallyCompose, exceptionallyComposeAsync, exceptionallyComposeAsync

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Method Details

handleAsync

default <U> Operation<U> handleAsync(BiFunction<? super T,Throwable,? extends U> fn,
 Executor executor)

Specified by:

handleAsync in interface CompletionStage<T>

handleAsync

default <U> Operation<U> handleAsync(BiFunction<? super T,Throwable,? extends U> fn)

Specified by:

handleAsync in interface CompletionStage<T>

handle

default <U> Operation<U> handle(BiFunction<? super T,Throwable,? extends U> fn)

Specified by:

handle in interface CompletionStage<T>

whenCompleteAsync

default Operation<T> whenCompleteAsync(BiConsumer<? super T,? super Throwable> action,
 Executor executor)

Specified by:

whenCompleteAsync in interface CompletionStage<T>

whenCompleteAsync

default Operation<T> whenCompleteAsync(BiConsumer<? super T,? super Throwable> action)

Specified by:

whenCompleteAsync in interface CompletionStage<T>

whenComplete

default Operation<T> whenComplete(BiConsumer<? super T,? super Throwable> action)

Specified by:

whenComplete in interface CompletionStage<T>

exceptionally

default Operation<T> exceptionally(Function<Throwable,? extends T> fn)

Specified by:

exceptionally in interface CompletionStage<T>

thenComposeAsync

default <U> Operation<U> thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn,
 Executor executor)

Specified by:

thenComposeAsync in interface CompletionStage<T>

thenComposeAsync

default <U> Operation<U> thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn)

Specified by:

thenComposeAsync in interface CompletionStage<T>

thenCompose

default <U> Operation<U> thenCompose(Function<? super T,? extends CompletionStage<U>> fn)

Specified by:

thenCompose in interface CompletionStage<T>

runAfterEitherAsync

default Operation<Void> runAfterEitherAsync(CompletionStage<?> other,
 Runnable action,
 Executor executor)

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

runAfterEitherAsync

default Operation<Void> runAfterEitherAsync(CompletionStage<?> other,
 Runnable action)

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

runAfterEither

default Operation<Void> runAfterEither(CompletionStage<?> other,
 Runnable action)

Specified by:

runAfterEither in interface CompletionStage<T>

acceptEitherAsync

default Operation<Void> acceptEitherAsync(CompletionStage<? extends T> other,
 Consumer<? super T> action,
 Executor executor)

Specified by:

acceptEitherAsync in interface CompletionStage<T>

acceptEitherAsync

default Operation<Void> acceptEitherAsync(CompletionStage<? extends T> other,
 Consumer<? super T> action)

Specified by:

acceptEitherAsync in interface CompletionStage<T>

acceptEither

default Operation<Void> acceptEither(CompletionStage<? extends T> other,
 Consumer<? super T> action)

Specified by:

acceptEither in interface CompletionStage<T>

applyToEitherAsync

default <U> Operation<U> applyToEitherAsync(CompletionStage<? extends T> other,
 Function<? super T,U> fn,
 Executor executor)

Specified by:

applyToEitherAsync in interface CompletionStage<T>

applyToEitherAsync

default <U> Operation<U> applyToEitherAsync(CompletionStage<? extends T> other,
 Function<? super T,U> fn)

Specified by:

applyToEitherAsync in interface CompletionStage<T>

applyToEither

default <U> Operation<U> applyToEither(CompletionStage<? extends T> other,
 Function<? super T,U> fn)

Specified by:

applyToEither in interface CompletionStage<T>

runAfterBothAsync

default Operation<Void> runAfterBothAsync(CompletionStage<?> other,
 Runnable action,
 Executor executor)

Specified by:

runAfterBothAsync in interface CompletionStage<T>

runAfterBothAsync

default Operation<Void> runAfterBothAsync(CompletionStage<?> other,
 Runnable action)

Specified by:

runAfterBothAsync in interface CompletionStage<T>

runAfterBoth

default Operation<Void> runAfterBoth(CompletionStage<?> other,
 Runnable action)

Specified by:

runAfterBoth in interface CompletionStage<T>

thenAcceptBothAsync

default <U> Operation<Void> thenAcceptBothAsync(CompletionStage<? extends U> other,
 BiConsumer<? super T,? super U> action,
 Executor executor)

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

thenAcceptBothAsync

default <U> Operation<Void> thenAcceptBothAsync(CompletionStage<? extends U> other,
 BiConsumer<? super T,? super U> action)

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

thenAcceptBoth

default <U> Operation<Void> thenAcceptBoth(CompletionStage<? extends U> other,
 BiConsumer<? super T,? super U> action)

Specified by:

thenAcceptBoth in interface CompletionStage<T>

thenCombineAsync

default <U,
V> Operation<V> thenCombineAsync(CompletionStage<? extends U> other,
 BiFunction<? super T,? super U,? extends V> fn,
 Executor executor)

Specified by:

thenCombineAsync in interface CompletionStage<T>

thenCombineAsync

default <U,
V> Operation<V> thenCombineAsync(CompletionStage<? extends U> other,
 BiFunction<? super T,? super U,? extends V> fn)

Specified by:

thenCombineAsync in interface CompletionStage<T>

thenCombine

default <U,
V> Operation<V> thenCombine(CompletionStage<? extends U> other,
 BiFunction<? super T,? super U,? extends V> fn)

Specified by:

thenCombine in interface CompletionStage<T>

thenRunAsync

default Operation<Void> thenRunAsync(Runnable action,
 Executor executor)

Specified by:

thenRunAsync in interface CompletionStage<T>

thenRunAsync

default Operation<Void> thenRunAsync(Runnable action)

Specified by:

thenRunAsync in interface CompletionStage<T>

thenRun

default Operation<Void> thenRun(Runnable action)

Specified by:

thenRun in interface CompletionStage<T>

thenAcceptAsync

default Operation<Void> thenAcceptAsync(Consumer<? super T> action,
 Executor executor)

Specified by:

thenAcceptAsync in interface CompletionStage<T>

thenAcceptAsync

default Operation<Void> thenAcceptAsync(Consumer<? super T> action)

Specified by:

thenAcceptAsync in interface CompletionStage<T>

thenAccept

default Operation<Void> thenAccept(Consumer<? super T> action)

Specified by:

thenAccept in interface CompletionStage<T>

thenApplyAsync

default <U> Operation<U> thenApplyAsync(Function<? super T,? extends U> fn,
 Executor executor)

Specified by:

thenApplyAsync in interface CompletionStage<T>

thenApplyAsync

default <U> Operation<U> thenApplyAsync(Function<? super T,? extends U> fn)

Specified by:

thenApplyAsync in interface CompletionStage<T>

thenApply

default <U> Operation<U> thenApply(Function<? super T,? extends U> fn)

Specified by:

thenApply in interface CompletionStage<T>

map

<U> Operation<U> map(Function<? super T,? extends U> fn)

Returns a new Operation that represents the synchronous mapping of this stages result using the provided function.

Type Parameters:

U - the function's return type

Parameters:

fn - the mapping function

Returns:

a new Operation

usingExecutor

default Operation<T> usingExecutor(Executor executor)

Returns a new Operation that uses the supplied executor as it's default async executor.

Parameters:

executor - async executor

Returns:

a new Operation

executor

default Executor executor()

Returns the default asynchronous execution pool for this operation.

Returns:

the default asynchronous execution pool

toCompletableFuture

default CompletableFuture<T> toCompletableFuture()

Specified by:

toCompletableFuture in interface CompletionStage<T>

toCompletableFuture

CompletableFuture<T> toCompletableFuture(Executor executor)

Returns a CompletableFuture maintaining the same completion properties as this stage using the supplied executor for any necessary synchronous calls.

Parameters:

executor - executor for sync calls

Returns:

the CompletableFuture

operation

static <T> Operation<T> operation(CompletableFuture<T> future)

Create an operation who's completion is tied to the given CompletableFuture.

Default async execution mode operations against the returned operation will use the invoking pool (if there is one) or the ForkJoinPool.commonPool() to poll the future when necessary.

Type Parameters:

T - the operations result type

Parameters:

future - underlying completable future

Returns:

a new operation

operation

static <T> Operation<T> operation(CompletableFuture<T> future,
 Executor executor)

/** Create an operation who's completion is tied to the given CompletableFuture.

Default async execution mode operations against the returned operation will use the supplied executor.

Type Parameters:

T - the operations result type

Parameters:

future - underlying completable future

executor - default async executor

Returns:

a new operation

operation

static <T> Operation<T> operation(Future<T> future)

Create an operation who's completion is tied to the given Future.

Default async execution mode operations against the returned operation will use the invoking pool (if there is one) or the ForkJoinPool.commonPool() to poll the future when necessary.

Type Parameters:

T - the operations result type

Parameters:

future - underlying future

Returns:

a new operation

operation

static <T> Operation<T> operation(Future<T> future,
 Executor executor)

Create an operation who's completion is tied to the given Future.

Default async execution mode operations against the returned operation will use the supplied executor.

Type Parameters:

T - the operations result type

Parameters:

future - underlying future

executor - default async executor

Returns:

a new operation