me.hltj.vertx.future.FutureTuple3 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-future-utils Show documentation
Convenient Utilities for Vert.x Future
There is a newer version: 1.1.2
/*
 * vertx-future-utils - Convenient Utilities for Vert.x Future
 * https://github.com/hltj/vertx-future-utils
 *
 * Copyright (C) 2020  JiaYanwei  https://hltj.me
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This code is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 *
 * Please contact me (jiaywe#at#gmail.com, replace the '#at#' with 'at')
 * if you need additional information or have any questions.
 */
package me.hltj.vertx.future;

import io.vertx.core.CompositeFuture;
import io.vertx.core.Future;
import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.ToString;
import lombok.experimental.FieldDefaults;
import me.hltj.vertx.FutureUtils;
import me.hltj.vertx.function.Function3;

import java.util.function.BiFunction;
import java.util.function.Consumer;

import static me.hltj.vertx.FutureUtils.defaultWith;
import static me.hltj.vertx.FutureUtils.fallbackWith;
import static me.hltj.vertx.future.InternalUtil.toFailureMapper;
import static me.hltj.vertx.future.InternalUtil.toSupplier;

/**
 * A tuple of 3 {@link Future}s.
 *
 * @param  the type parameter of the 1st {@code Future}
 * @param  the type parameter of the 2nd {@code Future}
 * @param  the type parameter of the 3rd {@code Future}
 */
@Getter
@AllArgsConstructor(staticName = "of")
@ToString(includeFieldNames = false)
@FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE)
public final class FutureTuple3 {
    Future _0;
    Future _1;
    Future _2;

    /**
     * Map the result of the {@link Future}s to {@code null}s.
     * 
     * It likes {@link FutureTuple2#mapEmpty()} but with 3-arity.
     */
    public FutureTuple3 mapEmpty() {
        return of(_0.mapEmpty(), _1.mapEmpty(), _2.mapEmpty());
    }

    /**
     * Map the failure of the {@link Future}s to specific values.
     * 

     * It likes {@link FutureTuple2#otherwise(Object, Object)} (Object, Object)} but with 3-arity.
     */
    public FutureTuple3 otherwise(T0 v0, T1 v1, T2 v2) {
        return of(_0.otherwise(v0), _1.otherwise(v1), _2.otherwise(v2));
    }

    /**
     * Map the failure of the {@link Future}s to specific values, and execute @{code onFailure} before mapping.
     * 

     * It likes {@link FutureTuple2#otherwise(Consumer, Object, Object)} but with 3-arity.
     */
    public FutureTuple3 otherwise(Consumer onFailure, T0 v0, T1 v1, T2 v2) {
        return of(
                _0.otherwise(toFailureMapper(onFailure, v0)),
                _1.otherwise(toFailureMapper(onFailure, v1)),
                _2.otherwise(toFailureMapper(onFailure, v2))
        );
    }

    /**
     * Map the failure of the {@link Future}s to {@code null}s.
     * 

     * It likes {@link FutureTuple2#otherwiseEmpty()} but with 3-arity.
     */
    public FutureTuple3 otherwiseEmpty() {
        return of(_0.otherwiseEmpty(), _1.otherwiseEmpty(), _2.otherwiseEmpty());
    }

    /**
     * Map {@link Future}s that succeed with null to default values.
     * 

     * It likes {@link FutureTuple2#defaults(Object, Object)} but with 3-arity.
     */
    public FutureTuple3 defaults(T0 v0, T1 v1, T2 v2) {
        return of(defaultWith(_0, v0), defaultWith(_1, v1), defaultWith(_2, v2));
    }

    /**
     * Map {@link Future}s that succeed with null to default values, and execute @{code onEmpty} before mapping.
     * 

     * It likes {@link FutureTuple2#defaults(Runnable, Object, Object)} but with 3-arity.
     */
    public FutureTuple3 defaults(Runnable onEmpty, T0 v0, T1 v1, T2 v2) {
        return of(
                FutureUtils.defaultWith(_0, toSupplier(onEmpty, v0)),
                FutureUtils.defaultWith(_1, toSupplier(onEmpty, v1)),
                FutureUtils.defaultWith(_2, toSupplier(onEmpty, v2))
        );
    }

    /**
     * Map {@link Future}s that failed or succeed with null to fallback values.
     * 

     * It likes {@link FutureTuple2#fallback(Object, Object)} but with 3-arity.
     */
    public FutureTuple3 fallback(T0 v0, T1 v1, T2 v2) {
        return of(fallbackWith(_0, v0), fallbackWith(_1, v1), fallbackWith(_2, v2));
    }

    /**
     * Map {@link Future}s that failed or succeed with null to default values, and execute @{code onFailure}
     * / @{code onEmpty} before mapping.
     * 

     * It likes {@link FutureTuple2#fallback(Consumer, Runnable, Object, Object)} but with 3-arity.
     */
    public FutureTuple3 fallback(Consumer onFailure, Runnable onEmpty, T0 v0, T1 v1, T2 v2) {
        return of(
                fallbackWith(_0, toFailureMapper(onFailure, v0), toSupplier(onEmpty, v0)),
                fallbackWith(_1, toFailureMapper(onFailure, v1), toSupplier(onEmpty, v1)),
                fallbackWith(_2, toFailureMapper(onFailure, v2), toSupplier(onEmpty, v2))
        );
    }

    /**
     * Composite this future tuple to a {@link CompositeFutureTuple3}
     * with {@link CompositeFuture#all(Future, Future, Future)}.
     * 

     * It likes {@link FutureTuple2#all()} but with 3-arity.
     */
    public CompositeFutureTuple3 all() {
        return compose(CompositeFuture::all);
    }

    /**
     * Composite this future tuple to a {@link CompositeFutureTuple3}
     * with {@link CompositeFuture#any(Future, Future, Future)}.
     * 

     * It likes {@link FutureTuple2#any()} but with 3-arity.
     */
    public CompositeFutureTuple3 any() {
        return compose(CompositeFuture::any);
    }

    /**
     * Composite this future tuple to a {@link CompositeFutureTuple3}
     * with {@link CompositeFuture#join(Future, Future, Future)}.
     * 

     * It likes {@link FutureTuple2#join()} but with 3-arity.
     */
    public CompositeFutureTuple3 join() {
        return compose(CompositeFuture::join);
    }

    /**
     * Composite this future tuple to a {@link CompositeFutureTuple3}.
     * 
     * It likes {@link FutureTuple2#compose(BiFunction)} but with 3-arity.
     */
    public CompositeFutureTuple3 compose(
            Function3, Future, Future, CompositeFuture> function3
    ) {
        return CompositeFutureTuple3.of(this, function3.apply(_0, _1, _2));
    }
}