play.libs

Class F.RedeemablePromise<A>

java.lang.Object

play.libs.F.Promise<A>

play.libs.F.RedeemablePromise<A>

Enclosing class:

F

public static class F.RedeemablePromise<A>
extends F.Promise<A>

RedeemablePromise is an object which can be completed with a value or failed with an exception.

 
 RedeemablePromise<Integer> someFutureInt = RedeemablePromise.empty();

 someFutureInt.map(new Function<Integer, Result>() {
     public Result apply(Integer i) {
         // This would apply once the redeemable promise succeed
         return Results.ok("" + i);
     }
 });

 // In another thread, you now may complete the RedeemablePromise.
 someFutureInt.success(42);
 
 

Method Summary

Modifier and Type	Method and Description
F.Promise<java.lang.Void>	completeWith(F.Promise other) Completes this promise with the specified Promise, once that Promise is completed.
F.Promise<java.lang.Void>	completeWith(F.Promise other, scala.concurrent.ExecutionContext ec) Completes this promise with the specified Promise, once that Promise is completed.
static <A> F.RedeemablePromise<A>	empty() Creates a new Promise with no value
void	failure(java.lang.Throwable t) Completes the promise with an exception
void	success(A a) Completes the promise with a value.
F.Promise<java.lang.Boolean>	tryCompleteWith(F.Promise other) Completes this promise with the specified Promise, once that Promise is completed.
F.Promise<java.lang.Boolean>	tryCompleteWith(F.Promise other, scala.concurrent.ExecutionContext ec) Completes this promise with the specified Promise, once that Promise is completed.

Methods inherited from class play.libs.F.Promise

delayed, delayed, fallbackTo, filter, filter, flatMap, flatMap, get, get, map, map, onFailure, onFailure, onRedeem, onRedeem, or, promise, promise, pure, recover, recover, recoverWith, recoverWith, sequence, sequence, sequence, sequence, throwing, timeout, timeout, timeout, timeout, transform, transform, wrap, wrapped, zip

Methods inherited from class java.lang.Object

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

Method Detail

empty

public static <A> F.RedeemablePromise<A> empty()

Creates a new Promise with no value

success

public void success(A a)

Completes the promise with a value.

Parameters:

a - The value to complete with

failure

public void failure(java.lang.Throwable t)

Completes the promise with an exception

Parameters:

t - The exception to fail the promise with

completeWith

public F.Promise<java.lang.Void> completeWith(F.Promise other)

Completes this promise with the specified Promise, once that Promise is completed.

Parameters:

other - The value to complete with

Returns:

A promise giving the result of attempting to complete this promise with the other promise. If the completion was successful then the result will be a null value, if the completion failed then the result will be an IllegalStateException.

completeWith

public F.Promise<java.lang.Void> completeWith(F.Promise other,
                                              scala.concurrent.ExecutionContext ec)

Completes this promise with the specified Promise, once that Promise is completed.

Parameters:

other - The value to complete with

ec - An execution context

Returns:

A promise giving the result of attempting to complete this promise with the other promise. If the completion was successful then the result will be a null value, if the completion failed then the result will be an IllegalStateException.

tryCompleteWith

public F.Promise<java.lang.Boolean> tryCompleteWith(F.Promise other)

Completes this promise with the specified Promise, once that Promise is completed.

Parameters:

other - The value to complete with

Returns:

A promise giving the result of attempting to complete this promise with the other promise. If the completion was successful then the result will be true, if the completion couldn't occur then the result will be false.

tryCompleteWith

public F.Promise<java.lang.Boolean> tryCompleteWith(F.Promise other,
                                                    scala.concurrent.ExecutionContext ec)

Completes this promise with the specified Promise, once that Promise is completed.

Parameters:

other - The value to complete with

ec - An execution context

Returns:

A promise giving the result of attempting to complete this promise with the other promise. If the completion was successful then the result will be true, if the completion couldn't occur then the result will be false.