com.github.morinb.func.CheckedFunction8 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of func Show documentation
Simple Functional interfaces for Java
There is a newer version: 1.8
/*
 * Copyright 2024 Baptiste MORIN
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.github.morinb.func;

import java.util.Objects;

/**
 * Function8 represents a function that accepts eight parameters and produces a result.
 *
 * @param  the type of the first parameter
 * @param  the type of the second parameter
 * @param  the type of the third parameter
 * @param  the type of the fourth parameter
 * @param  the type of the fifth parameter
 * @param  the type of the sixth parameter
 * @param  the type of the seventh parameter
 * @param  the type of the eighth parameter
 * @param   the type of the result
 */
@FunctionalInterface
public interface CheckedFunction8
{
    /**
     * Applies a function to the given eight parameters and returns the result.
     *
     * @param param1 the first parameter of type T1
     * @param param2 the second parameter of type T2
     * @param param3 the third parameter of type T3
     * @param param4 the fourth parameter of type T4
     * @param param5 the fifth parameter of type T5
     * @param param6 the sixth parameter of type T6
     * @param param7 the seventh parameter of type T7
     * @param param8 the eighth parameter of type T8
     * @return the result of applying the function to the parameters
     * @throws Throwable if an exception occurs during function execution
     */
    @SuppressWarnings({"squid:S107", "squid:S112"})
    R apply(T1 param1, T2 param2, T3 param3, T4 param4, T5 param5, T6 param6, T7 param7, T8 param8) throws Throwable;

    /**
     * Composes this function with another function, applying the other function after this function.
     *
     * @param    the type of the result of the other function
     * @param after the other function to apply
     * @return a composed function that applies the other function after this function
     * @throws NullPointerException if the other function is null
     */
    default  CheckedFunction8 andThen(final CheckedFunction1 after)
    {
        Objects.requireNonNull(after, "after is null");
        return (T1 param1, T2 param2, T3 param3, T4 param4, T5 param5, T6 param6, T7 param7, T8 param8) -> after.apply(apply(param1, param2, param3, param4, param5, param6, param7, param8));
    }

    /**
     * Returns a curried version of the function.
     *
     * @return a curried version of the function
     */
    default CheckedFunction1>>>>>>> curried()
    {
        return param1 -> param2 -> param3 -> param4 -> param5 -> param6 -> param7 -> param8 -> apply(param1, param2, param3, param4, param5, param6, param7, param8);
    }
}