Constructor Detail

• F.Promise

  public F.Promise(scala.concurrent.Future<A> promise)

  Create a new promise wrapping the given Scala promise

  Parameters:

  promise - The scala promise to wrap

Method Detail

• resetActors

  public static void resetActors()

• sequence

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

  Combine the given promises into a single promise for the list of results.

  Parameters:

  promises - The promises to combine

  Returns:

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

• waitAll

  @Deprecated
  public static <A> F.Promise<java.util.List<A>> waitAll(F.Promise<? extends A>... promises)

  Deprecated. As of release 2.1, replaced by sequence(play.libs.F.Promise<? extends A>...)
  Combine the given promises into a single promise for the list of results.

  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,
                         java.lang.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<scala.Unit> timeout()
                                       throws java.util.concurrent.TimeoutException

  Create a Promise timer that is throwing a TimeoutException after the default timeout duration expires. The returned Promise is usually combined with other Promises.

  Returns:

  a promise without a real value

  Throws:

  java.util.concurrent.TimeoutException

• timeout

  public static <A> F.Promise<A> timeout(A message,
                         java.lang.Long delay)

  Create a Promise that is redeemed after a timeout.

  Parameters:

  message - The message to use to redeem the Promise.

  delay - The delay expressed in Milliseconds.

• sequence

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

  Combine the given promises into a single promise for the list of results.

  Parameters:

  promises - The promises to combine

  Returns:

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

• waitAll

  @Deprecated
  public static <A> F.Promise<java.util.List<A>> waitAll(java.lang.Iterable<F.Promise<? extends A>> promises)

  Deprecated. As of release 2.1, replaced by sequence(play.libs.F.Promise<? extends A>...)
  Combine the given promises into a single promise for the list of results.

  Parameters:

  promises - The promises to combine

  Returns:

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

• pure

  public static <A> F.Promise<A> pure(A a)

  Create a new pure promise, that is, a promise with a constant value from the start.

  Parameters:

  a - the value for the promise

• throwing

  public static <A> F.Promise<A> throwing(java.lang.Throwable throwable)

  Create a new promise throwing an exception.

  Parameters:

  throwable - Value to throw

• get

  public A get()

  Awaits for the promise to get the result using the default timeout (5000 milliseconds).

  Returns:

  The promised object

  Throws:

  java.lang.RuntimeException - if the calculation providing the promise threw an exception

• get

  public A get(java.lang.Long timeout,
      java.util.concurrent.TimeUnit unit)

  Awaits for the promise to get the result.

  Parameters:

  timeout - A user defined timeout

  unit - timeout for timeout

  Returns:

  The promised result

  Throws:

  java.lang.RuntimeException - if the calculation providing the promise threw an exception

• get

  public A get(java.lang.Long timeout)

  Awaits for the promise to get the result.

  Parameters:

  timeout - A user defined timeout in milliseconds

  Returns:

  The promised result

  Throws:

  java.lang.RuntimeException - if the calculation providing the promise threw an exception

• or

  public <B> F.Promise<F.Either<A,B>> or(F.Promise<B> another)

  combines the current promise with another promise using `or`

  Parameters:

  another -

• onRedeem

  public void onRedeem(F.Callback<A> action)

  Perform the given action callback when the Promise is redeemed.

  Parameters:

  action - The action to perform.

• map

  public <B> F.Promise<B> map(F.Function<A,B> function)

  Maps this promise to a promise of type B. The function function is applied as soon as the promise is redeemed. Exceptions thrown by function will be wrapped in RuntimeException, unless they are RuntimeException's themselves.

  Parameters:

  function - The function to map A to B.

  Returns:

  A wrapped promise that maps the type from A to B.

• recover

  public F.Promise<A> recover(F.Function<java.lang.Throwable,A> function)

  Wraps this promise in a promise that will handle exceptions thrown by this Promise. Exceptions thrown by function will be wrapped in RuntimeException, unless they are RuntimeException's themselves.

  Parameters:

  function - The function to handle the exception. This may, for example, convert the exception into something of type T, or it may throw another exception, or it may do some other handling.

  Returns:

  A wrapped promise that will only throw an exception if the supplied function throws an exception.

• flatMap

  public <B> F.Promise<B> flatMap(F.Function<A,F.Promise<B>> function)

  Maps the result of this promise to a promise for a result of type B, and flattens that to be a single promise for B. Exceptions thrown by function will be wrapped in RuntimeException, unless they are RuntimeException's themselves.

  Parameters:

  function - The function to map A to a promise for B.

  Returns:

  A wrapped promise for a result of type B

• getWrappedPromise

  public scala.concurrent.Future<A> getWrappedPromise()

  Get the underlying Scala promise

  Returns:

  The scala promise