PromisedReply

java.lang.Object
- co.tinode.tinodesdk.PromisedReply<T>

```
public class PromisedReply<T>
extends java.lang.Object
```
A very simple thanable promise. It has no facility for execution. It can only be resolved/rejected externally by calling resolve/reject. Once resolved/rejected it will call listener's onSuccess/onFailure. Depending on results returned or thrown by the handler, it will update the next promise in chain: will either resolve/reject it immediately, or make it resolve/reject together with the promise returned by the handler. Usage: Create a PromisedReply P1, assign onSuccess/onFailure listeners by calling thenApply. thenApply returns another P2 promise (mNextPromise), which can then be assigned its own listeners. Alternatively, one can use a blocking call getResult. It will block until the promise is either resolved or rejected. The promise can be created in either WAITING or RESOLVED state by using an appropriate constructor. The onSuccess/onFailure handlers will be called: a. Called at the time of resolution when P1 is resolved through P1.resolve(T) if at the time of calling thenApply the promise is in WAITING state, b. Called immediately on thenApply if at the time of calling thenApply the promise is already in RESOLVED or REJECTED state, thenApply creates and returns a promise P2 which will be resolved/rejected in the following manner: A. If P1 is resolved: 1. If P1.onSuccess returns a resolved promise P3, P2 is resolved immediately on return from onSuccess using the result from P3. 2. If P1.onSuccess returns a rejected promise P3, P2 is rejected immediately on return from onSuccess using the throwable from P3. 2. If P1.onSuccess returns null, P2 is resolved immediately using result from P1. 3. If P1.onSuccess returns an unresolved promise P3, P2 is resolved together with P3. 4. If P1.onSuccess throws an exception, P2 is rejected immediately on catching the exception. 5. If P1.onSuccess is null, P2 is resolved immediately using result from P1. B. If P1 is rejected: 1. If P1.onFailure returns a resolved promise P3, P2 is resolved immediately on return from onFailure using the result from P3. 2. If P1.onFailure returns null, P2 is resolved immediately using null as a result. 3. If P1.onFailure returns an unresolved promise P3, P2 is resolved together with P3. 4. If P1.onFailure throws an exception, P2 is rejected immediately on catching the exception. 5. If P1.onFailure is null, P2 is rejected immediately using the throwable from P1. 5.1 If P2.onFailure is null, and P2.mNextPromise is null, an exception is re-thrown.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PromisedReply.FailureListener<U>`
`static class`	`PromisedReply.FinalListener`
`static class`	`PromisedReply.SuccessListener<U>`

Constructor Summary

Constructors
Constructor and Description
`PromisedReply()` Create promise in a WAITING state.
`PromisedReply(E err)` Create a promise in a REJECTED state
`PromisedReply(T result)` Create a promise in a RESOLVED state

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PromisedReply<java.lang.Void>`	`allOf(PromisedReply[] waitFor)` Returns a new PromisedReply that is completed when all of the given PromisedReply complete.
`T`	`getResult()` A blocking call which returns the result of the execution.
`boolean`	`isDone()`
`boolean`	`isRejected()`
`boolean`	`isResolved()`
`void`	`reject(java.lang.Exception err)` Make this promise rejected.
`void`	`resolve(T result)` Make this promise resolved.
`PromisedReply<T>`	`thenApply(PromisedReply.SuccessListener<T> success)` Calls SuccessListener.onSuccess when the promise is resolved.
`PromisedReply<T>`	`thenApply(PromisedReply.SuccessListener<T> success, PromisedReply.FailureListener<T> failure)` Call SuccessListener.onSuccess or FailureListener.onFailure when the promise is resolved or rejected.
`PromisedReply<T>`	`thenCatch(PromisedReply.FailureListener<T> failure)` Call onFailure when the promise is rejected.
`void`	`thenFinally(PromisedReply.FinalListener finished)` Call FinalListener.onFinally when the promise is completed.
`boolean`	`waitResult()` Wait for promise resolution.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PromisedReply
```
public PromisedReply()
```
    Create promise in a WAITING state.
  - PromisedReply
```
public PromisedReply(T result)
```
    Create a promise in a RESOLVED state
    
    Parameters:
    
    result - result used for resolution of the promise.
  - PromisedReply
```
public PromisedReply(E err)
```
    Create a promise in a REJECTED state
    
    Parameters:
    
    err - Exception used for rejecting the promise.
- Method Detail
  - allOf
```
public static PromisedReply<java.lang.Void> allOf(PromisedReply[] waitFor)
```
    Returns a new PromisedReply that is completed when all of the given PromisedReply complete.
    
    Parameters:
    
    waitFor - promises to wait for.
    
    Returns:
    
    new PromisedReply that is completed when all of the given PromisedReply complete.
  - thenApply
```
public PromisedReply<T> thenApply(PromisedReply.SuccessListener<T> success,
                                  PromisedReply.FailureListener<T> failure)
```
    Call SuccessListener.onSuccess or FailureListener.onFailure when the promise is resolved or rejected. The call will happen on the thread which called resolve() or reject().
    
    Parameters:
    
    success - called when the promise is resolved
    
    failure - called when the promise is rejected
    
    Returns:
    
    promise for chaining
  - thenApply
```
public PromisedReply<T> thenApply(PromisedReply.SuccessListener<T> success)
```
    Calls SuccessListener.onSuccess when the promise is resolved. The call will happen on the thread which called resolve().
    
    Parameters:
    
    success - called when the promise is resolved
    
    Returns:
    
    promise for chaining
  - thenCatch
```
public PromisedReply<T> thenCatch(PromisedReply.FailureListener<T> failure)
```
    Call onFailure when the promise is rejected. The call will happen on the thread which called reject()
    
    Parameters:
    
    failure - called when the promise is rejected
    
    Returns:
    
    promise for chaining
  - thenFinally
```
public void thenFinally(PromisedReply.FinalListener finished)
```
    Call FinalListener.onFinally when the promise is completed. The call will happen on the thread which completed the promise: called either resolve() or reject().
    
    Parameters:
    
    finished - called when the promise is completed either way.
  - isResolved
```
public boolean isResolved()
```
  - isRejected
```
public boolean isRejected()
```
  - isDone
```
public boolean isDone()
```
  - resolve
```
public void resolve(T result)
             throws java.lang.Exception
```
    Make this promise resolved.
    
    Parameters:
    
    result - results of resolution.
    
    Throws:
    
    java.lang.Exception - if anything goes wrong during resolution.
  - reject
```
public void reject(java.lang.Exception err)
            throws java.lang.Exception
```
    Make this promise rejected.
    
    Parameters:
    
    err - reason for rejecting this promise.
    
    Throws:
    
    java.lang.Exception - if anything goes wrong during rejection.
  - waitResult
```
public boolean waitResult()
                   throws java.lang.InterruptedException
```
    Wait for promise resolution.
    
    Returns:
    
    true if the promise was resolved, false otherwise
    
    Throws:
    
    java.lang.InterruptedException - if waiting was interrupted
  - getResult
```
public T getResult()
            throws java.lang.Exception
```
    A blocking call which returns the result of the execution. It will return after thenApply is called. It can be safely called multiple times on the same instance.
    
    Returns:
    
    result of the execution (what was passed to resolve(Object))
    
    Throws:
    
    java.lang.Exception - if the promise was rejected or waiting was interrupted.

Class PromisedReply<T>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PromisedReply

PromisedReply

PromisedReply

Method Detail

allOf

thenApply

thenApply

thenCatch

thenFinally

isResolved

isRejected

isDone

resolve

reject

waitResult

getResult