play.libs.concurrent

Interface Futures

All Known Implementing Classes:

DefaultFutures

public interface Futures

Utilities for creating CompletionStage.

Method Summary

Modifier and Type	Method and Description
<A> java.util.concurrent.CompletionStage<A>	delayed(java.util.concurrent.CompletionStage<A> stage, java.time.Duration duration) Create a CompletionStage which, after a delay, will be redeemed with the result of a given supplier.
<A> java.util.concurrent.CompletionStage<A>	delayed(java.util.concurrent.CompletionStage<A> stage, long amount, java.util.concurrent.TimeUnit unit) Create a CompletionStage which, after a delay, will be redeemed with the result of a given supplier.
static <A> java.util.concurrent.CompletionStage<A>	delayed(java.util.function.Supplier<A> supplier, long delay, java.util.concurrent.TimeUnit unit, java.util.concurrent.Executor executor) Deprecated. Use injected play.libs.concurrent.Futures.delayed, since 2.6.0
static <A> java.util.concurrent.CompletionStage<java.util.List<A>>	sequence(java.util.concurrent.CompletionStage<A>... promises) Combine the given CompletionStages into a single CompletionStage for the list of results.
static <A> java.util.concurrent.CompletionStage<java.util.List<A>>	sequence(java.lang.Iterable<? extends java.util.concurrent.CompletionStage<A>> promises) Combine the given CompletionStages into a single CompletionStage for the list of results.
static <A> java.util.concurrent.CompletionStage<A>	timeout(A value, long amount, java.util.concurrent.TimeUnit unit) Deprecated. Use injected play.libs.concurrent.Futures.timeout, since 2.6.0
<A> java.util.concurrent.CompletionStage<A>	timeout(java.util.concurrent.CompletionStage<A> stage, java.time.Duration duration) An alias for futures(stage, delay, unit) that uses a java.time.Duration.
<A> java.util.concurrent.CompletionStage<A>	timeout(java.util.concurrent.CompletionStage<A> stage, long amount, java.util.concurrent.TimeUnit unit) Creates a CompletionStage that returns either the input stage, or a futures.
static <A> java.util.concurrent.CompletionStage<A>	timeout(long delay, java.util.concurrent.TimeUnit unit) Deprecated. Use injected play.libs.concurrent.Futures.timeout, since 2.6.0

Method Detail

timeout

<A> java.util.concurrent.CompletionStage<A> timeout(java.util.concurrent.CompletionStage<A> stage,
                                                    long amount,
                                                    java.util.concurrent.TimeUnit unit)

Creates a CompletionStage that returns either the input stage, or a futures. Note that futures is not the same as cancellation. Even in case of futures, the given completion stage will still complete, even though that completed value is not returned.

Type Parameters:

A - the completion's result type.

Parameters:

stage - the input completion stage that may time out.

amount - The amount (expressed with the corresponding unit).

unit - The time Unit.

Returns:

either the completed future, or a completion stage that failed with futures.

timeout

<A> java.util.concurrent.CompletionStage<A> timeout(java.util.concurrent.CompletionStage<A> stage,
                                                    java.time.Duration duration)

An alias for futures(stage, delay, unit) that uses a java.time.Duration.

Type Parameters:

A - the completion stage that should be wrapped with a future.

Parameters:

stage - the input completion stage that may time out.

duration - The duration after which there is a timeout.

Returns:

the completion stage, or a completion stage that failed with futures.

delayed

<A> java.util.concurrent.CompletionStage<A> delayed(java.util.concurrent.CompletionStage<A> stage,
                                                    long amount,
                                                    java.util.concurrent.TimeUnit unit)

Create a CompletionStage which, after a delay, will be redeemed with the result of a given supplier. The supplier will be called after the delay.

Type Parameters:

A - the type of the completion's result.

Parameters:

stage - the input completion stage that is delayed.

amount - The time to wait.

unit - The units to use for the amount.

Returns:

the delayed CompletionStage wrapping supplier.

delayed

<A> java.util.concurrent.CompletionStage<A> delayed(java.util.concurrent.CompletionStage<A> stage,
                                                    java.time.Duration duration)

Create a CompletionStage which, after a delay, will be redeemed with the result of a given supplier. The supplier will be called after the delay.

Type Parameters:

A - the type of the completion's result.

Parameters:

stage - the input completion stage that is delayed.

duration - to wait.

Returns:

the delayed CompletionStage wrapping supplier.

sequence

static <A> java.util.concurrent.CompletionStage<java.util.List<A>> sequence(java.lang.Iterable<? extends java.util.concurrent.CompletionStage<A>> promises)

Combine the given CompletionStages into a single CompletionStage for the list of results. The sequencing operations are performed in the default ExecutionContext.

Type Parameters:

A - the type of the completion's result.

Parameters:

promises - The CompletionStages to combine

Returns:

A single CompletionStage whose methods act on the list of redeemed CompletionStages

sequence

static <A> java.util.concurrent.CompletionStage<java.util.List<A>> sequence(java.util.concurrent.CompletionStage<A>... promises)

Combine the given CompletionStages into a single CompletionStage for the list of results. The sequencing operations are performed in the default ExecutionContext.

Type Parameters:

A - the type of the completion's result.

Parameters:

promises - The CompletionStages to combine

Returns:

A single CompletionStage whose methods act on the list of redeemed CompletionStage

timeout

@Deprecated
static <A> java.util.concurrent.CompletionStage<A> timeout(A value,
                                                                       long amount,
                                                                       java.util.concurrent.TimeUnit unit)

Deprecated. Use injected play.libs.concurrent.Futures.timeout, since 2.6.0

Create a CompletionStage that is redeemed after a timeout. This method is useful for returning fallback values on futures. The underlying implementation uses TimerTask, which has a resolution in milliseconds.

Type Parameters:

A - the type of the completion's result.

Parameters:

value - The result value to use to complete the CompletionStage.

amount - The amount (expressed with the corresponding unit).

unit - The time unit, i.e. java.util.concurrent.TimeUnit.MILLISECONDS

Returns:

the CompletionStage wrapping the result value

timeout

@Deprecated
static <A> java.util.concurrent.CompletionStage<A> timeout(long delay,
                                                                       java.util.concurrent.TimeUnit unit)

Deprecated. Use injected play.libs.concurrent.Futures.timeout, since 2.6.0

Creates a CompletionStage timer that throws a PromiseTimeoutException after a given timeout. The returned CompletionStage is usually combined with other CompletionStage, i.e. completionStage.applyToEither(Futures.timeout(delay, unit), Function.identity()) The underlying implementation uses TimerTask, which has a resolution in milliseconds. A previous implementation used CompletionStage<Void> which made it unsuitable for composition. Cast with Futures.<Void>timeout if necessary.

Type Parameters:

A - the type of the completion's result.

Parameters:

delay - The delay (expressed with the corresponding unit).

unit - The time Unit.

Returns:

a CompletionStage that failed exceptionally

delayed

@Deprecated
static <A> java.util.concurrent.CompletionStage<A> delayed(java.util.function.Supplier<A> supplier,
                                                                       long delay,
                                                                       java.util.concurrent.TimeUnit unit,
                                                                       java.util.concurrent.Executor executor)

Deprecated. Use injected play.libs.concurrent.Futures.delayed, since 2.6.0

Create a CompletionStage which, after a delay, will be redeemed with the result of a given supplier. The supplier will be called after the delay.

Type Parameters:

A - the type of the completion's result.

Parameters:

supplier - The supplier to call to fulfill the CompletionStage.

delay - The time to wait.

unit - The units to use for the delay.

executor - The executor to run the supplier in.

Returns:

the delayed CompletionStage wrapping supplier.