play.libs.concurrent

Class Futures

java.lang.Object

play.libs.concurrent.Futures

public class Futures
extends java.lang.Object

Utilities for creating CompletionStage.

Constructor Summary

Constructors

Constructor and Description
Futures()

Method Summary

Modifier and Type	Method and Description
static <A> F.Promise<A>	delayed(java.util.function.Supplier<A> supplier, long delay, java.util.concurrent.TimeUnit unit, java.util.concurrent.Executor executor) Create a Promise which, after a delay, will be redeemed with the result of a given supplier.
static <A> F.Promise<java.util.List<A>>	sequence(java.util.concurrent.CompletionStage<A>... promises) Combine the given promises into a single promise for the list of results.
static <A> F.Promise<java.util.List<A>>	sequence(java.lang.Iterable<? extends java.util.concurrent.CompletionStage<A>> promises) Combine the given promises into a single promise for the list of results.
static <A> F.Promise<A>	timeout(A message, long delay, java.util.concurrent.TimeUnit unit) Create a Promise that is redeemed after a timeout.
static F.Promise<java.lang.Void>	timeout(long delay, java.util.concurrent.TimeUnit unit) Create a Promise timer that throws a PromiseTimeoutException after a given timeout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Futures

public Futures()

Method Detail

sequence

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

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

Parameters:

promises - The promises to combine

Returns:

A single promise whose methods act on the list of redeemed promises

sequence

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

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

Parameters:

promises - The promises to combine

Returns:

A single promise whose methods act on the list of redeemed promises

timeout

public static <A> F.Promise<A> timeout(A message,
                                       long delay,
                                       java.util.concurrent.TimeUnit unit)

Create a Promise that is redeemed after a timeout.

Parameters:

message - The message to use to redeem the Promise.

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

unit - The Unit.

timeout

public static F.Promise<java.lang.Void> timeout(long delay,
                                                java.util.concurrent.TimeUnit unit)

Create a Promise timer that throws a PromiseTimeoutException after a given timeout. The returned Promise is usually combined with other Promises.

Parameters:

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

unit - The Unit.

Returns:

a promise without a real value

delayed

public static <A> F.Promise<A> delayed(java.util.function.Supplier<A> supplier,
                                       long delay,
                                       java.util.concurrent.TimeUnit unit,
                                       java.util.concurrent.Executor executor)

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

Parameters:

supplier - The supplier to call to fulfill the Promise.

delay - The time to wait.

unit - The units to use for the delay.

executor - The executor to run the supplier in.