io.vlingo.common.PentaFunction Maven / Gradle / Ivy
Show all versions of vlingo-common Show documentation
// Copyright © 2012-2020 VLINGO LABS. All rights reserved.
//
// This Source Code Form is subject to the terms of the
// Mozilla Public License, v. 2.0. If a copy of the MPL
// was not distributed with this file, You can obtain
// one at https://mozilla.org/MPL/2.0/.
package io.vlingo.common;
import java.util.Objects;
import java.util.function.Function;
/**
* Represents a function that accepts five arguments and produces a result.
* This is the five-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 first argument to the function
* @param the type of the second argument to the function
* @param the type of the third argument to the function
* @param the type of the fourth argument to the function
* @param the type of the fifth argument to the function
* @param the type of the result of the function
*
* @see Function
*/
@FunctionalInterface
public interface PentaFunction {
/**
* Applies this function to the given arguments.
*
* @param t the first function argument
* @param u the second function argument
* @param v the third function argument
* @param w the fourth function argument
* @param x the fifth function argument
*
* @return the function result
*/
R apply(T t, U u, V v, W w, X x);
/**
* 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 PentaFunction andThen(Function after) {
Objects.requireNonNull(after);
return (T t, U u, V v, W w, X x) -> after.apply(apply(t, u, v, w, x));
}
}