com.cyngn.vertx.async.promise.Promise Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-util Show documentation
A library for using opentsdb with vert.x
There is a newer version: 0.6.0
package com.cyngn.vertx.async.promise;

import io.vertx.core.Vertx;
import io.vertx.core.json.JsonObject;

import java.util.function.Consumer;

/**
 * Represents a set of one or more asynchronous actions.
 *
 * @author [email protected] (Jeremy Truelove) 7/30/15
 */
public interface Promise {

    String CONTEXT_FAILURE_KEY = "failure";

    /**
     * Executes all actions in parallel
     *
     * @param actions the actions to execute
     * @return the promise representing the actions
     */
    Promise all(PromiseAction ... actions);

    /**
     * Executes all actions serially
     *
     * @param actions the actions to execute
     * @return the promise representing the actions
     */
    Promise allInOrder(PromiseAction ... actions);

    /**
     * Add an action to execute in the chain.
     *
     * @param action the action to execute
     * @return the promise representing the actions
     */
    Promise then(PromiseAction action);

    /**
     * Add an exception handler to be called in the event something goes wrong.
     *
     * @param onFailure the callback to call on failure
     * @return the promise representing the actions
     */
    Promise except(Consumer onFailure);

    /**
     * The callback to call when all promise actions are done. This will only be called if there are no failures.
     * @param onComplete the callback to hit when the promise is complete
     * @return the promise representing the actions
     */
    Promise done(Consumer onComplete);

    /**
     * A timeout to set on the promise.
     * @param time the delay in milliseconds that the promise needs to complete in
     * @return the promise representing the actions
     */
    Promise timeout(long time);

    /**
     * Has the promise succeeded? Will return false while still executing.
     *
     * @return true if the promise has succeeded false otherwise
     */
    boolean succeeded();

    /**
     * Has the promise completed yet? Either by completing all tasks or failing to.
     *
     * @return true if all actions or done completing or the promise has failed.
     */
    boolean completed();

    /**
     * Called when you are ready to begin resolution of the promise chain.
     *
     * @return the promise you are evaluating
     */
    Promise eval();

    /**
     * If the promise has no actions in it
     *
     * @return true if the promise has no actions, false otherwise
     */
    boolean isEmpty();

    /**
     * Create a new promise.
     * @param vertx the vertx instance to run it on
     * @return the newly created Promise
     */
    static Promise newInstance(Vertx vertx) {
        return new PromiseImpl(vertx);
    }
}