com.cyngn.vertx.async.promise.PromiseFactory 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;

/**
 * Handles generating promises that can be executed on the Vert.x eventloop, allows you to not keep track of vert.x
 *  instance.
 *
 * @author [email protected] (Jeremy Truelove) 7/30/15
 */
public class PromiseFactory {

    private final Vertx vertx;

    /**
     * Initialize a promise factory with a reference to your vertx event loop
     * @param vertx the vertx event loop to run your promises on
     */
    public PromiseFactory(Vertx vertx) {
        this.vertx = vertx;
    }

    /**
     * Create an empty promise.
     *
     * @return a new empty promise
     */
    public Promise create() {
        return Promise.newInstance(vertx);
    }

    /**
     * Create a promise with a list of actions to be executed serially.
     *
     * @param actions the actions to execute
     * @return the promise representing the actions
     */
    public Promise createSerial(PromiseAction ... actions) {
        return Promise.newInstance(vertx).allInOrder(actions);
    }

    /**
     * Create a promise with a list of actions to be executed in parallel.
     *
     * @param actions the actions to execute
     * @return the promise representing the actions
     */
    public Promise createParallel(PromiseAction ... actions) {
        return Promise.newInstance(vertx).all(actions);
    }
}