Class PgxFuture<T>

java.lang.Object

java.util.concurrent.CompletableFuture<T>

oracle.pgx.api.PgxFuture<T>

All Implemented Interfaces:

CompletionStage<T>, Future<T>

public class PgxFuture<T>
extends CompletableFuture<T>

A PGX-specific extension of CompletableFuture

Nested Class Summary

Nested classes/interfaces inherited from class CompletableFuture

CompletableFuture.AsynchronousCompletionTask

Nested classes/interfaces inherited from interface Future

Future.State

Constructor Summary

Constructors

Constructor	Description
PgxFuture()

Method Summary

Modifier and Type	Method	Description
static <T> PgxFuture<Void>	allOf(List<PgxFuture<T>> promises)
boolean	cancel()
PgxFuture<T>	cancelOn(PgxFuture promise)	If given promise completes exceptionally because it was canceled, CompletableFuture.cancel(boolean) gets called on this promise as well.
static <T> PgxFuture<T>	completedFuture(T arg)
PgxFuture<T>	exceptionally(Function<Throwable, ? extends T> fn)
static <T> PgxFuture<T>	exceptionallyCompletedFuture(Throwable throwable)
T	get()
T	get(long timeout, TimeUnit unit)
T	getNow(T valueIfAbsent)
FutureProgress	getProgress()	compute statistics about the progress and estimation to finish a PgxFuture Currently only supported for Graph loading features
<U> PgxFuture<U>	handle(BiFunction<? super T, Throwable, ? extends U> fn)
boolean	isConsumed()
T	join()
PgxFuture<Void>	thenAccept(Consumer<? super T> block)
<U> PgxFuture<U>	thenApply(Function<? super T, ? extends U> function)
<U> PgxFuture<U>	thenApplyAsync(Function<? super T, ? extends U> function, Executor executor)
<U,V> PgxFuture<V>	thenCombine(CompletableFuture<? extends U> other, BiFunction<? super T, ? super U, ? extends V> function)
PgxFuture<T>	thenComplete(PgxFuture<T> promise)	completes the given promise whenever this completes.
PgxFuture<T>	thenComplete(PgxFuture<T> promise, Runnable cleanup)	completes the given promise whenever this completes.
<U> PgxFuture<U>	thenCompose(Function<? super T, ? extends CompletionStage<U>> function)
<U> PgxFuture<U>	thenReturn(U result)	A future that discards its result and returns the given parameter on completion.

Methods inherited from class CompletableFuture

acceptEither, acceptEitherAsync, acceptEitherAsync, allOf, anyOf, applyToEither, applyToEitherAsync, applyToEitherAsync, cancel, complete, completeAsync, completeAsync, completedStage, completeExceptionally, completeOnTimeout, copy, defaultExecutor, delayedExecutor, delayedExecutor, exceptionallyAsync, exceptionallyAsync, exceptionallyCompose, exceptionallyComposeAsync, exceptionallyComposeAsync, exceptionNow, failedFuture, failedStage, getNumberOfDependents, handleAsync, handleAsync, isCancelled, isCompletedExceptionally, isDone, minimalCompletionStage, newIncompleteFuture, obtrudeException, obtrudeValue, orTimeout, resultNow, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, runAsync, runAsync, state, supplyAsync, supplyAsync, thenAcceptAsync, thenAcceptAsync, thenAcceptBoth, thenAcceptBothAsync, thenAcceptBothAsync, thenApplyAsync, thenCombine, thenCombineAsync, thenCombineAsync, thenComposeAsync, thenComposeAsync, thenRun, thenRunAsync, thenRunAsync, toCompletableFuture, toString, whenComplete, whenCompleteAsync, whenCompleteAsync

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

PgxFuture

public PgxFuture()

Method Details

allOf

public static <T> PgxFuture<Void> allOf(List<PgxFuture<T>> promises)

completedFuture

public static <T> PgxFuture<T> completedFuture(@Nullable
 T arg)

exceptionallyCompletedFuture

public static <T> PgxFuture<T> exceptionallyCompletedFuture(Throwable throwable)

thenApply

public <U> PgxFuture<U> thenApply(Function<? super T, ? extends U> function)

Specified by:

thenApply in interface CompletionStage<T>

Overrides:

thenApply in class CompletableFuture<T>

thenApplyAsync

public <U> PgxFuture<U> thenApplyAsync(Function<? super T, ? extends U> function,
 Executor executor)

Specified by:

thenApplyAsync in interface CompletionStage<T>

Overrides:

thenApplyAsync in class CompletableFuture<T>

thenCombine

public <U,V> PgxFuture<V> thenCombine(CompletableFuture<? extends U> other,
 BiFunction<? super T, ? super U, ? extends V> function)

thenReturn

public <U> PgxFuture<U> thenReturn(U result)

A future that discards its result and returns the given parameter on completion.

Shortcut for thenApply(t -> result).

Parameters:

result - the result to return on completion of this future

Returns:

a future returning the result on completion

get

public T get()
      throws InterruptedException,
ExecutionException

Specified by:

get in interface Future<T>

Overrides:

get in class CompletableFuture<T>

Throws:

InterruptedException

ExecutionException

get

public T get(long timeout,
 TimeUnit unit)
      throws InterruptedException,
ExecutionException,
TimeoutException

Specified by:

get in interface Future<T>

Overrides:

get in class CompletableFuture<T>

Throws:

InterruptedException

ExecutionException

TimeoutException

getNow

public T getNow(T valueIfAbsent)

Overrides:

getNow in class CompletableFuture<T>

join

public T join()

Overrides:

join in class CompletableFuture<T>

thenAccept

public PgxFuture<Void> thenAccept(Consumer<? super T> block)

Specified by:

thenAccept in interface CompletionStage<T>

Overrides:

thenAccept in class CompletableFuture<T>

handle

public <U> PgxFuture<U> handle(BiFunction<? super T, Throwable, ? extends U> fn)

Specified by:

handle in interface CompletionStage<T>

Overrides:

handle in class CompletableFuture<T>

thenCompose

public <U> PgxFuture<U> thenCompose(Function<? super T, ? extends CompletionStage<U>> function)

Specified by:

thenCompose in interface CompletionStage<T>

Overrides:

thenCompose in class CompletableFuture<T>

exceptionally

public PgxFuture<T> exceptionally(Function<Throwable, ? extends T> fn)

Specified by:

exceptionally in interface CompletionStage<T>

Overrides:

exceptionally in class CompletableFuture<T>

thenComplete

public PgxFuture<T> thenComplete(PgxFuture<T> promise)

completes the given promise whenever this completes.

If this completes exceptionally, the given promise is completed exceptionally as well.

Parameters:

promise - the promise

Returns:

the pgx future

thenComplete

public PgxFuture<T> thenComplete(PgxFuture<T> promise,
 Runnable cleanup)

completes the given promise whenever this completes.

If this completes exceptionally, the given promise is completed exceptionally as well.

Parameters:

promise -

cleanup - to be run upon completion (can be null)

Returns:

the given promise

cancel

public boolean cancel()

cancelOn

public PgxFuture<T> cancelOn(PgxFuture promise)

If given promise completes exceptionally because it was canceled, CompletableFuture.cancel(boolean) gets called on this promise as well.

Parameters:

promise - If given promise completes exceptionally because it was canceled, CompletableFuture.cancel(boolean) gets called on this promise as well. If given promise completes exceptionally (regardless of the causing exception) and this promise has started or is done, this promise is then rolled back.

Returns:

this

isConsumed

public boolean isConsumed()

getProgress

public FutureProgress getProgress()

compute statistics about the progress and estimation to finish a PgxFuture Currently only supported for Graph loading features

Parameters:

future - a pgx future

Returns:

progress of the future execution