Promise (java-promise 1.1.0 API)

java.lang.Object
- org.riversun.promise.Promise

All Implemented Interfaces:

Thennable
```
public class Promise
extends Object
implements Thennable
```
You can chain asynchronous operations and execute them sequentially by using Promise. Of course, not only asynchronous operations but also synchronous operations can be chained. Example Code Promise.resolve() .then((action, data) -> { new Thread(() -> { // Do something System.out.println("process-1"); action.resolve("result-1"); }).start(); }) .then((action, data) -> { new Thread(() -> { // Do something try { Thread.sleep(1000); } catch (InterruptedException e) { } System.out.println("process-2"); action.resolve("result-1"); }).start(); }) .then((action, data) -> { new Thread(() -> { // Do something System.out.println("process-3"); action.resolve("result-1"); }).start(); }); Result in: process-1 process-2 process-3

Author:

Tom Misawa (riversun.org@gmail.com)

Field Summary

Fields
Modifier and Type Field Description

String mName

Fields
Modifier and Type	Field	Description
`String`	`mName`

Constructor Summary

Constructors
Constructor	Description
`Promise()`
`Promise(String name, ExecutorService executor)`
`Promise(String name, Func func)`
`Promise(String name, Func func, ExecutorService executor)`
`Promise(ExecutorService executor)`
`Promise(Func func)`
`Promise(Func func, ExecutorService executor)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Promise`	`all(ExecutorService executor, Func... funcs)`
`static Promise`	`all(ExecutorService executor, Thennable... promises)`
`static Promise`	`all(Func... funcs)`	Promise.all waits for all fulfillments (or the first rejection).
`static Promise`	`all(Thennable... promises)`	Promise.all waits for all fulfillments (or the first rejection).
`Promise`	`always(Func func)`
`Promise`	`always(Thennable promise)`
`ExecutorService`	`createExecutor()`
`Status`	`getStatus()`
`Object`	`getValue()`
`static Promise`	`reject()`	Returns a Promise object that is rejected with null reason.
`static Promise`	`reject(Object reason)`	Returns a Promise object that is rejected with a given reason.
`static Promise`	`resolve()`	Returns a Promise object that is resolved with null value
`static Promise`	`resolve(Object data)`	Returns a Promise object that is fulfilled with a given data
`static Promise`	`resolve(Object data, ExecutorService executor)`	Returns a Promise object that is fulfilled with a given data and specify executor
`void`	`runOnThread(Runnable r)`
`static void`	`sleep(long millis)`
`Promise`	`start()`
`Promise`	`then(Func... funcs)`	Specify the operation to be performed after the promise processing.
`Promise`	`then(Thennable... promises)`

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

- Field Detail
  - mName
```
public String mName
```
- Constructor Detail
  - Promise
```
public Promise()
```
  - Promise
```
public Promise(String name,
               Func func,
               ExecutorService executor)
```
  - Promise
```
public Promise(String name,
               ExecutorService executor)
```
  - Promise
```
public Promise(ExecutorService executor)
```
  - Promise
```
public Promise(Func func,
               ExecutorService executor)
```
  - Promise
```
public Promise(String name,
               Func func)
```
  - Promise
```
public Promise(Func func)
```
- Method Detail
  - createExecutor
```
public ExecutorService createExecutor()
```
  - then
```
public Promise then(Func... funcs)
```
    Specify the operation to be performed after the promise processing. In this method,you can specify only "Func" instead of doing "new Promise(func)".You may omit "new Promise(func)".
    
    Specified by:
    
    then in interface Thennable
    
    Parameters:
    
    onFulfilled - ,[onRejected]
    
    Returns:
    
    Promise
  - always
```
public Promise always(Thennable promise)
```
    Specified by:
    
    always in interface Thennable
  - always
```
public Promise always(Func func)
```
    Specified by:
    
    always in interface Thennable
  - then
```
public Promise then(Thennable... promises)
```
    Specified by:
    
    then in interface Thennable
  - start
```
public Promise start()
```
    Specified by:
    
    start in interface Thennable
  - runOnThread
```
public void runOnThread(Runnable r)
```
  - getStatus
```
public Status getStatus()
```
    Specified by:
    
    getStatus in interface Thennable
  - getValue
```
public Object getValue()
```
    Specified by:
    
    getValue in interface Thennable
  - resolve
```
public static Promise resolve(Object data,
                              ExecutorService executor)
```
    Returns a Promise object that is fulfilled with a given data and specify executor
    
    Parameters:
    
    data -
    
    executor -
    
    Returns:
  - resolve
```
public static Promise resolve(Object data)
```
    Returns a Promise object that is fulfilled with a given data
    
    Parameters:
    
    data -
    
    Returns:
  - resolve
```
public static Promise resolve()
```
    Returns a Promise object that is resolved with null value
    
    Parameters:
    
    data -
    
    Returns:
  - reject
```
public static Promise reject(Object reason)
```
    Returns a Promise object that is rejected with a given reason.
    
    Parameters:
    
    reason -
    
    Returns:
  - reject
```
public static Promise reject()
```
    Returns a Promise object that is rejected with null reason.
    
    Parameters:
    
    reason -
    
    Returns:
  - all
```
public static Promise all(Thennable... promises)
```
    Promise.all waits for all fulfillments (or the first rejection). Promise.all is rejected if any of the elements are rejected. For example, if you pass in four promises that resolve after a sleep and one promise that rejects immediately, then Promise.all will reject immediately. Since each promise is executed on its own worker thread, the execution of the promise itself continues on the worker thread. But, once reject received, Promise.all will move on to then when it receives reject even if the worker thread is moving If fulfilled, all results are returned as "List
    " at Func#run(Action, List

Class Promise

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mName

Constructor Detail

Promise

Promise

Promise

Promise

Promise

Promise

Promise

Method Detail

createExecutor

then

always

always

then

start

runOnThread

getStatus

getValue

resolve

resolve

resolve

reject

reject

all

all

all

all

sleep