com.tinkerpop.gremlin.util.function.SQuintFunction Maven / Gradle / Ivy

Go to download
package com.tinkerpop.gremlin.util.function;

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

/**
 * Represents a function that accepts four arguments and produces a result. This is the arity-4 specialization of
 * Function.
 * 
 * This is a functional interface whose functional method is apply(Object, Object, Object).
 *
 * @param  the type of the first argument in the function
 * @param  the type of the second argument in the function
 * @param  the type of the third argument in the function
 * @param  the type of the fourth argument in the function
 * @param  the type of the fifth argument in the function
 * @param  the type of the result of the function
 * @author Stephen Mallette (http://stephen.genoprime.com)
 */
@FunctionalInterface
public interface SQuintFunction extends Serializable {

    /**
     * Applies this function to the given arguments.
     *
     * @param a the first argument to the function
     * @param b the second argument to the function
     * @param c the third argument to the function
     * @param d the fourth argument to the function
     * @param e the fifth argument to the function
     * @return the function result
     */
    public R apply(final A a, final B b, final C c, final D d, final E e);

    /**
     * Returns a composed function that first applies this function to its input, and then applies the after function
     * to the result. If evaluation of either function throws an exception, it is relayed to the caller of the composed
     * function.
     *
     * @param after the function to apply after this function is applied
     * @param    the type of the output of the {@code after} function, and of the composed function
     * @return a composed function that first applies this function and then applies the {@code after} function.
     * @throws NullPointerException if {@code after} is null
     */
    public default  SQuintFunction andThen(final Function after) {
        Objects.requireNonNull(after);
        return (A a, B b, C c, D d, E e) -> after.apply(apply(a, b, c, d, e));
    }
}