me.hltj.vertx.future.CompositeFutureTuple5 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.ToString;
import me.hltj.vertx.function.*;

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

import static me.hltj.vertx.FutureUtils.joinWrap;

/**
 * The composite {@link Future} tuple warps a {@link CompositeFuture} and a {@link FutureTuple5}.
 * 
 * Not only retains the type parameters of the original {@code Future}s,
 * but also provide many convenient operations as a complement to {@code CompositeFuture}.
 *
 * @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}
 * @param  the type parameter of the 4th {@code Future}
 * @param  the type parameter of the 5th {@code Future}
 */
@ToString(includeFieldNames = false)
final public class CompositeFutureTuple5 extends CompositeFutureWrapper {
    private final FutureTuple5 tuple5;

    private CompositeFutureTuple5(CompositeFuture composite, FutureTuple5 tuple5) {
        super(composite);
        this.tuple5 = tuple5;
    }

    /**
     * Create a {@link CompositeFutureTuple5} based on a {@link CompositeFuture} and a {@link FutureTuple5}.
     *
     * @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}
     * @param     the type parameter of the 4th {@code Future}
     * @param     the type parameter of the 5th {@code Future}
     * @param tuple5  the {@code FutureTuple5}
     * @param compose the {@code CompositeFuture}
     * @return the {@code CompositeFutureTuple5}
     */
    public static  CompositeFutureTuple5 of(
            FutureTuple5 tuple5, CompositeFuture compose
    ) {
        return new CompositeFutureTuple5<>(compose, tuple5);
    }

    /**
     * Return the original {@link FutureTuple5}.
     */
    public FutureTuple5 tuple() {
        return tuple5;
    }

    /**
     * Run side-effect code likes {@link CompositeFutureWrapper#use(Consumer)}, but the {@code consumer6} takes the
     * original 5 {@link Future}s as additional parameters.
     * 

     * It likes {@link CompositeFutureTuple2#use(Consumer3)} but with 5-arity.
     */
    public void use(Consumer6, Future, Future, Future, Future> consumer6) {
        consumer6.accept(composite, tuple5.get_0(), tuple5.get_1(), tuple5.get_2(), tuple5.get_3(), tuple5.get_4());
    }

    /**
     * Map the original {@link CompositeFuture} and the original 5 {@link Future}s.
     * 

     * It likes {@link CompositeFutureTuple2#with(Function3)} but with 5-arity.
     */
    public  R with(
            Function6, Future, Future, Future, Future, R> function6
    ) {
        return function6.apply(
                composite, tuple5.get_0(), tuple5.get_1(), tuple5.get_2(), tuple5.get_3(), tuple5.get_4()
        );
    }

    /**
     * Alias for {@link #through(Function5)}.
     */
    public  Future mapAnyway(Function5, Future, Future, Future, Future, R> function5) {
        return through(function5);
    }

    /**
     * Map a function that takes the original 5 {@link Future}s on complete no matter whether succeeded or failed.
     * 

     * It likes {@link CompositeFutureTuple2#through(BiFunction)} but with 5-arity.
     */
    public  Future through(Function5, Future, Future, Future, Future, R> function5) {
        return joinThrough(function5.andThen(Future::succeededFuture));
    }

    /**
     * Alias for {@link #joinThrough(Function5)}.
     */
    public  Future flatMapAnyway(
            Function5, Future, Future, Future, Future, Future> function5
    ) {
        return joinThrough(function5);
    }

    /**
     * Map a function that takes the original 5 {@link Future}s on complete no matter whether succeeded or failed,
     * and join (also known as {@code flatten}) the result before return.
     *
     * 

     * It likes {@link CompositeFutureTuple2#joinThrough(BiFunction)} but with 5-arity.
     */
    public  Future joinThrough(
            Function5, Future, Future, Future, Future, Future> function5
    ) {
        Supplier> supplier = () -> function5.apply(
                tuple5.get_0(), tuple5.get_1(), tuple5.get_2(), tuple5.get_3(), tuple5.get_4()
        );
        return composite.compose(_x -> joinWrap(supplier), _t -> joinWrap(supplier));
    }

    /**
     * Alias for {@link CompositeFutureTuple5#applift(Function5)}.
     */
    public  Future mapTyped(Function5 function5) {
        return applift(function5);
    }

    /**
     * Apply a function that accept all results of the original {@link Future}s on success, and return
     * a {@link Future}.
     * 

     * It likes {@link CompositeFutureTuple2#applift(BiFunction)} but with 5-arity.
     */
    public  Future applift(Function5 function5) {
        return composite.map(future -> function5.apply(
                composite.resultAt(0), composite.resultAt(1), composite.resultAt(2), composite.resultAt(3),
                composite.resultAt(4)
        ));
    }

    /**
     * Alias for {@link CompositeFutureTuple5#joinApplift(Function5)}.
     */
    public  Future flatMapTyped(Function5> function5) {
        return joinApplift(function5);
    }

    /**
     * Apply a function that accept all results of the original {@link Future}s on success, and return
     * a {@link Future}, where the function itself return a {@link Future}.
     * 
     * It likes {@link CompositeFutureTuple2#joinApplift(BiFunction)} but with 5-arity.
     */
    public  Future joinApplift(Function5> function5) {
        return composite.flatMap(future -> function5.apply(
                composite.resultAt(0), composite.resultAt(1), composite.resultAt(2), composite.resultAt(3),
                composite.resultAt(4)
        ));
    }
}