com.github.jparkie.promise

Class Promises

java.lang.Object

com.github.jparkie.promise.Promises

public final class Promises
extends java.lang.Object

A companion class for Promise. Provides various methods for creating promises.

Method Summary

Modifier and Type	Method and Description
static <T> Promise<T>	create(Scheduler scheduler, Action<T> onScheduleAction) Returns a promise scheduled to be resolved by the specified action.
static <T> Promise<T>	error(java.lang.Throwable error) Returns a new promise which wraps the provided error.
static <T> Promise<T>	promise() Returns a new unresolved promise.
static <T> Promise<T>	value(T value) Returns a new promise which wraps the provided value.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <T> Promise<T> create(Scheduler scheduler,
                                    Action<T> onScheduleAction)

Returns a promise scheduled to be resolved by the specified action. Upon cancellation, the specified cancelFlag procedure will be called.

Type Parameters:

T - The type of the value promised to be available now, or in the future, or never.

Parameters:

scheduler - The scheduler to call the action.

onScheduleAction - The action to resolve the provided promise.

Returns:

The created promise.

promise

public static <T> Promise<T> promise()

Returns a new unresolved promise.

Type Parameters:

T - The type of the value promised to be available now, or in the future, or never.

Returns:

The unresolved promise.

value

public static <T> Promise<T> value(T value)

Returns a new promise which wraps the provided value.

Type Parameters:

T - The type of the value promised to be available now, or in the future, or never.

Parameters:

value - The value to lift into a promise.

Returns:

The new promise.

error

public static <T> Promise<T> error(java.lang.Throwable error)

Returns a new promise which wraps the provided error.

Type Parameters:

T - The type of the value promised to be available now, or in the future, or never.

Parameters:

error - The error to lift into a promise.

Returns:

The new promise.