me.hltj.vertx.function.Function5 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.function;

import java.util.Objects;
import java.util.function.Function;

/**
 * Represents a function that accepts 5 arguments and produces a result.
 * This is the 5-arity specialization of {@link Function}.
 *
 * This is a functional interface
 * whose functional method is {@link #apply(Object, Object, Object, Object, Object)}.
 *
 * @param  the type of the 1st argument to the function
 * @param  the type of the 2nd argument to the function
 * @param  the type of the 3rd argument to the function
 * @param  the type of the 4th argument to the function
 * @param  the type of the 5th argument to the function
 * @param   the type of the result of the function
 * @see Function
 */
@FunctionalInterface
public interface Function5 {

    /**
     * Applies this function to the given arguments.
     *
     * @param v0 the 1st function argument
     * @param v1 the 2nd function argument
     * @param v2 the 3rd function argument
     * @param v3 the 4th function argument
     * @param v4 the 5th function argument
     * @return the function result
     */
    R apply(T0 v0, T1 v1, T2 v2, T3 v3, T4 v4);

    /**
     * Returns a composed function that first applies this function to
     * its input, and then applies the {@code after} function to the result.
     * If evaluation of either function throws an exception, it is relayed to
     * the caller of the composed function.
     *
     * @param   the type of output of the {@code after} function, and of the
     *              composed function
     * @param after the function to apply after this function is applied
     * @return a composed function that first applies this function and then
     * applies the {@code after} function
     * @throws NullPointerException if after is null
     */
    default  Function5 andThen(Function after) {
        Objects.requireNonNull(after);
        return (T0 v0, T1 v1, T2 v2, T3 v3, T4 v4) -> after.apply(apply(v0, v1, v2, v3, v4));
    }
}