All Downloads are FREE. Search and download functionalities are using the official Maven repository.

ternary.checked.ObjObjIntToObjE Maven / Gradle / Ivy

There is a newer version: 2.0
Show newest version
package net.mintern.functions.ternary.checked;

/**
 * An operation of type {@code (T, U, int) -> R}.
 *
 * @param  the type of argument 1
 * @param  the type of argument 2
 * @param  the type of the return value
 * @param  the {@code Exception} type that the operation may throw
 */
@FunctionalInterface
public interface ObjObjIntToObjE {

    /**
     * Performs this operation.
     *
     * @param t argument 1
     * @param u argument 2
     * @param i argument 3
     * @return the result of the operation
     * @throws E if the operation cannot be completed
     */
    R call(T t, U u, int i) throws E;

    /**
     * Binds {@code (t)} to the beginning of {@code f}, returning a new function
     * of type {@code (U, int) -> R}.
     *
     * @param  the type of argument 1
     * @param  the type of argument 2
     * @param  the type of the return value
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param t argument 1
     * @return a new function {@code (U u, int i) -> R} that calls
     *      {@code f.call(t, u, i)} and returns the result.
     */
    static  net.mintern.functions.binary.checked.ObjIntToObjE
    bind(ObjObjIntToObjE f, T t) {
        return (u, i) -> f.call(t, u, i);
    }

    /**
     * Binds {@code (t)} to the beginning of {@code this}, returning a new function
     * of type {@code (U, int) -> R}.
     *
     * @param t argument 1
     * @return a new function {@code (U u, int i) -> R} that calls
     *      {@code this.call(t, u, i)} and returns the result.
     */
    default net.mintern.functions.binary.checked.ObjIntToObjE bind(T t) {
        return ObjObjIntToObjE.bind(this, t);
    }

    /**
     * Binds {@code (u, i)} to the end of {@code f}, returning a new function
     * of type {@code (T) -> R}.
     *
     * @param  the type of argument 1
     * @param  the type of argument 2
     * @param  the type of the return value
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param u argument 2
     * @param i argument 3
     * @return a new function {@code (T t) -> R} that calls
     *      {@code f.call(t, u, i)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.ObjToObjE
    rbind(ObjObjIntToObjE f, U u, int i) {
        return (t) -> f.call(t, u, i);
    }

    /**
     * Binds {@code (u, i)} to the end of {@code this}, returning a new function
     * of type {@code (T) -> R}.
     *
     * @param u argument 2
     * @param i argument 3
     * @return a new function {@code (T t) -> R} that calls
     *      {@code this.call(t, u, i)} and returns the result.
     */
    default net.mintern.functions.unary.checked.ObjToObjE rbind(U u, int i) {
        return ObjObjIntToObjE.rbind(this, u, i);
    }

    /**
     * Binds {@code (t, u)} to the beginning of {@code f}, returning a new function
     * of type {@code (int) -> R}.
     *
     * @param  the type of argument 1
     * @param  the type of argument 2
     * @param  the type of the return value
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param t argument 1
     * @param u argument 2
     * @return a new function {@code (int i) -> R} that calls
     *      {@code f.call(t, u, i)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.IntToObjE
    bind(ObjObjIntToObjE f, T t, U u) {
        return (i) -> f.call(t, u, i);
    }

    /**
     * Binds {@code (t, u)} to the beginning of {@code this}, returning a new function
     * of type {@code (int) -> R}.
     *
     * @param t argument 1
     * @param u argument 2
     * @return a new function {@code (int i) -> R} that calls
     *      {@code this.call(t, u, i)} and returns the result.
     */
    default net.mintern.functions.unary.checked.IntToObjE bind(T t, U u) {
        return ObjObjIntToObjE.bind(this, t, u);
    }

    /**
     * Binds {@code (i)} to the end of {@code f}, returning a new function
     * of type {@code (T, U) -> R}.
     *
     * @param  the type of argument 1
     * @param  the type of argument 2
     * @param  the type of the return value
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param i argument 3
     * @return a new function {@code (T t, U u) -> R} that calls
     *      {@code f.call(t, u, i)} and returns the result.
     */
    static  net.mintern.functions.binary.checked.ObjObjToObjE
    rbind(ObjObjIntToObjE f, int i) {
        return (t, u) -> f.call(t, u, i);
    }

    /**
     * Binds {@code (i)} to the end of {@code this}, returning a new function
     * of type {@code (T, U) -> R}.
     *
     * @param i argument 3
     * @return a new function {@code (T t, U u) -> R} that calls
     *      {@code this.call(t, u, i)} and returns the result.
     */
    default net.mintern.functions.binary.checked.ObjObjToObjE rbind(int i) {
        return ObjObjIntToObjE.rbind(this, i);
    }

    /**
     * Binds {@code (t, u, i)} to {@code f}, returning a new function
     * of type {@code () -> R}.
     *
     * @param  the type of argument 1
     * @param  the type of argument 2
     * @param  the type of the return value
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param t argument 1
     * @param u argument 2
     * @param i argument 3
     * @return a new function {@code () -> R} that calls
     *      {@code f.call(t, u, i)} and returns the result.
     */
    @SuppressWarnings("unchecked") // maven spuriously warns about a type error in this case
    static  net.mintern.functions.nullary.checked.NilToObjE
    bind(ObjObjIntToObjE f, T t, U u, int i) {
        return () -> f.call(t, u, i);
    }

    /**
     * Binds {@code (t, u, i)} to {@code this}, returning a new function
     * of type {@code () -> R}.
     *
     * @param t argument 1
     * @param u argument 2
     * @param i argument 3
     * @return a new function {@code () -> R} that calls
     *      {@code this.call(t, u, i)} and returns the result.
     */
    default net.mintern.functions.nullary.checked.NilToObjE bind(T t, U u, int i) {
        return ObjObjIntToObjE.bind(this, t, u, i);
    }
}