001package Torello.Java.Function;
002
003import java.util.function.Function;
004
005/**
006 * Function-Pointer
007 * <SPAN CLASS=TJF>Input:</SPAN> {@code A, B, C}
008 * <SPAN CLASS=TJF>Output:</SPAN> {@code R}.
009 * 
010 * <BR /><BR />
011 * <EMBED CLASS='external-html' DATA-FILE-ID=BIG_FUNCTION>
012 * <EMBED CLASS="globalDefs" DATA-Name='Tri Function' DATA-Number=three>
013 * 
014 * @param <A> The type of the first input-parameter.
015 * @param <B> The type of the second input-parameter.
016 * @param <C> The type of the last input-parameter.
017 * @param <R> The type of the function-output.
018 */
019@FunctionalInterface
020public interface TriFunction<A, B, C, R>
021{
022    /**
023     * Applies {@code 'this'} function to the given arguments.
024     * <BR /><BR /><EMBED CLASS='external-html' DATA-FILE-ID=FUNC_INTER_METH>
025     *
026     * @param a the first input argument
027     * @param b the second input argument
028     * @param c the third input argument
029     * @return The result of the function.  Return result is of type {@code 'R'}
030     */
031    public R apply(A a, B b, C c);
032
033    /**
034     * <EMBED CLASS='external-html' DATA-FILE-ID=FUNC_THEN_METHOD>
035     * @param after <EMBED CLASS='external-html' DATA-FILE-ID=FUNC_THEN_AFTER>
036     * 
037     * @return a composed {@code 'TriFunction'}, that first applies {@code 'this'} function, and
038     * then applies the {@code 'after'} function.
039     * 
040     * @throws NullPointerException This is thrown if {@code 'after'} is null.
041     */
042    default <V> TriFunction<A, B, C, V> andThen(Function<? super R, ? extends V> after)
043    {
044        if (after == null)
045            throw new NullPointerException("parameter 'after' has been passed null.");
046
047        return (A a, B b, C c) -> after.apply(this.apply(a, b, c));
048    }
049 
050}