ru.progrm_jarvis.javacommons.util.function.ThrowingFunction Maven / Gradle / Ivy

Go to download

package ru.progrm_jarvis.javacommons.util.function;

import lombok.SneakyThrows;

import java.util.function.Function;

/**
 * An extension of {@link Function} allowing throwing calls in its body.
 *
 * @param  the type of the input to the function
 * @param  the type of the result of the function
 * @param  the type of the exception thrown by the function
 */
@FunctionalInterface
public interface ThrowingFunction extends Function {

    /**
     * Applies this function to the given argument.
     *
     * @param t the function argument
     * @return the function result
     * @throws X if an exception happens
     */
    R invoke(T t) throws X;

    @Override
    @SneakyThrows
    default R apply(final T t) {
        return invoke(t);
    }
}