org.openzen.zengarden.promise

Class ResolvedPromise<R,S,E extends java.lang.Throwable>

java.lang.Object

org.openzen.zengarden.promise.ResolvedPromise<R,S,E>

All Implemented Interfaces:

Promise<R,S,E>

public class ResolvedPromise<R,S,E extends java.lang.Throwable>
extends java.lang.Object
implements Promise<R,S,E>

Represents a resolved promise. Returned if a task has an immediate result.

Constructor Summary

Constructors

Constructor and Description
ResolvedPromise(R response, java.lang.Class<E> errorClass)
ResolvedPromise(R response, java.lang.Class<E> errorClass, Consumer<java.lang.Runnable> runner)

Method Summary

Modifier and Type	Method and Description
R	get() Retrieves a result synchronously.
java.lang.Class<E>	getErrorClass() Retrieves the error class.
Promise<R,S,E>	onCached(Consumer<R> consumer) Registers a consumer to be called when cached data becomes available.
Promise<R,S,E>	onDone(Consumer<R> consumer) Registers a consumer to be called when the call has finished.
Promise<R,S,E>	onFail(Consumer<E> consumer) Registers a consumer to be called when an error occurs.
Promise<R,S,E>	onStatus(Consumer<S> consumer) Registers a consumer to be called when status updates are available.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openzen.zengarden.promise.Promise

onData, pipe

Constructor Detail

ResolvedPromise

public ResolvedPromise(R response,
                       java.lang.Class<E> errorClass)

ResolvedPromise

public ResolvedPromise(R response,
                       java.lang.Class<E> errorClass,
                       Consumer<java.lang.Runnable> runner)

Method Detail

getErrorClass

public java.lang.Class<E> getErrorClass()

Description copied from interface: Promise

Retrieves the error class. Used to perform proper error handling.

Specified by:

getErrorClass in interface Promise<R,S,E extends java.lang.Throwable>

Returns:

error class

onDone

public Promise<R,S,E> onDone(Consumer<R> consumer)

Description copied from interface: Promise

Registers a consumer to be called when the call has finished. The consumer might be called immediately.

Specified by:

onDone in interface Promise<R,S,E extends java.lang.Throwable>

Parameters:

consumer - result consumer

Returns:

this promise

onCached

public Promise<R,S,E> onCached(Consumer<R> consumer)

Description copied from interface: Promise

Registers a consumer to be called when cached data becomes available. The consumer might be called immediately.

Specified by:

onCached in interface Promise<R,S,E extends java.lang.Throwable>

Parameters:

consumer - cached value consumer

Returns:

this promise

onStatus

public Promise<R,S,E> onStatus(Consumer<S> consumer)

Description copied from interface: Promise

Registers a consumer to be called when status updates are available. This consumer might be called any number of times, or not at all.

Specified by:

onStatus in interface Promise<R,S,E extends java.lang.Throwable>

Parameters:

consumer - status consumer

Returns:

this promise

onFail

public Promise<R,S,E> onFail(Consumer<E> consumer)

Description copied from interface: Promise

Registers a consumer to be called when an error occurs.

Specified by:

onFail in interface Promise<R,S,E extends java.lang.Throwable>

Parameters:

consumer - error consumer

Returns:

this promise

get

public R get()
      throws E extends java.lang.Throwable

Description copied from interface: Promise

Retrieves a result synchronously. Might wait return a result immediately, wait until one is a available, or throw an exception if an error occurs.

Specified by:

get in interface Promise<R,S,E extends java.lang.Throwable>

Returns:

resulting value

Throws:

E - if the request failed

E extends java.lang.Throwable