com.liferay.apio.architect.function.throwable.ThrowablePentaFunction Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library 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 2.1 of the License, or (at your option)
* any later version.
*
* This library 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.
*/
package com.liferay.apio.architect.function.throwable;
import aQute.bnd.annotation.ConsumerType;
import java.util.Objects;
/**
* Defines a {@code PentaFunction} that can throw an exception.
*
* @author Alejandro Hernández
* @param the type of the first argument of the function
* @param the type of the second argument of the function
* @param the type of the third argument of the function
* @param the type of the fourth argument of the function
* @param the type of the fifth argument of the function
* @param the type of the result of the function
*/
@ConsumerType
@FunctionalInterface
public interface ThrowablePentaFunction {
/**
* Returns the {@code ThrowablePentaFunction} that first executes the
* current {@code ThrowablePentaFunction} instance's {@code apply} method,
* then uses the result as input for the {@code afterFunction} parameter's
* {@code apply} method.
*
* @param throwableFunction the {@code ThrowablePentaFunction} to execute
* after the current instance
* @return the {@code ThrowablePentaFunction} that executes the current
* instance's {@code apply} method, then uses the result as input
* for the {@code throwableFunction} parameter's {@code apply}
* method
*/
public default ThrowablePentaFunction andThen(
ThrowableFunction throwableFunction) {
Objects.requireNonNull(throwableFunction);
return (A a, B b, C c, D d, E e) -> throwableFunction.apply(
apply(a, b, c, d, e));
}
/**
* Applies the current {@code ThrowablePentaFunction} and returns a value of
* type {@code R}. This function can be implemented explicitly or with a
* lambda.
*
* @param a the function's first argument
* @param b the function's second argument
* @param c the function's third argument
* @param d the function's fourth argument
* @param e the function's fifth argument
* @return the function's result, as a value of type {@code R}
*/
public R apply(A a, B b, C c, D d, E e) throws Exception;
}