net.mintern.functions.ternary.checked.IntObjObjToNilE Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of functions-ternary-core Show documentation
Provides functional interfaces for the most commonly used two-argument functions
There is a newer version: 2.0
Show newest version
package net.mintern.functions.ternary.checked;

/**
 * An operation of type {@code (int, U, V) -> void}.
 *
 * @param  the type of argument 2
 * @param  the type of argument 3
 * @param  the {@code Exception} type that the operation may throw
 */
@FunctionalInterface
public interface IntObjObjToNilE {

    /**
     * Performs this operation.
     *
     * @param i argument 1
     * @param u argument 2
     * @param v argument 3
     * @throws E if the operation cannot be completed
     */
    void call(int i, U u, V v) throws E;

    /**
     * Binds {@code (i)} to the beginning of {@code f}, returning a new function
     * of type {@code (U, V) -> void}.
     *
     * @param  the type of argument 2
     * @param  the type of argument 3
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param i argument 1
     * @return a new function {@code (U u, V v) -> void} that calls
     *      {@code f.call(i, u, v)}.
     */
    static  net.mintern.functions.binary.checked.ObjObjToNilE
    bind(IntObjObjToNilE f, int i) {
        return (u, v) -> f.call(i, u, v);
    }

    /**
     * Binds {@code (i)} to the beginning of {@code this}, returning a new function
     * of type {@code (U, V) -> void}.
     *
     * @param i argument 1
     * @return a new function {@code (U u, V v) -> void} that calls
     *      {@code this.call(i, u, v)}.
     */
    default net.mintern.functions.binary.checked.ObjObjToNilE bind(int i) {
        return IntObjObjToNilE.bind(this, i);
    }

    /**
     * Binds {@code (u, v)} to the end of {@code f}, returning a new function
     * of type {@code (int) -> void}.
     *
     * @param  the type of argument 2
     * @param  the type of argument 3
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param u argument 2
     * @param v argument 3
     * @return a new function {@code (int i) -> void} that calls
     *      {@code f.call(i, u, v)}.
     */
    static  net.mintern.functions.unary.checked.IntToNilE
    rbind(IntObjObjToNilE f, U u, V v) {
        return (i) -> f.call(i, u, v);
    }

    /**
     * Binds {@code (u, v)} to the end of {@code this}, returning a new function
     * of type {@code (int) -> void}.
     *
     * @param u argument 2
     * @param v argument 3
     * @return a new function {@code (int i) -> void} that calls
     *      {@code this.call(i, u, v)}.
     */
    default net.mintern.functions.unary.checked.IntToNilE rbind(U u, V v) {
        return IntObjObjToNilE.rbind(this, u, v);
    }

    /**
     * Binds {@code (i, u)} to the beginning of {@code f}, returning a new function
     * of type {@code (V) -> void}.
     *
     * @param  the type of argument 2
     * @param  the type of argument 3
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param i argument 1
     * @param u argument 2
     * @return a new function {@code (V v) -> void} that calls
     *      {@code f.call(i, u, v)}.
     */
    static  net.mintern.functions.unary.checked.ObjToNilE
    bind(IntObjObjToNilE f, int i, U u) {
        return (v) -> f.call(i, u, v);
    }

    /**
     * Binds {@code (i, u)} to the beginning of {@code this}, returning a new function
     * of type {@code (V) -> void}.
     *
     * @param i argument 1
     * @param u argument 2
     * @return a new function {@code (V v) -> void} that calls
     *      {@code this.call(i, u, v)}.
     */
    default net.mintern.functions.unary.checked.ObjToNilE bind(int i, U u) {
        return IntObjObjToNilE.bind(this, i, u);
    }

    /**
     * Binds {@code (v)} to the end of {@code f}, returning a new function
     * of type {@code (int, U) -> void}.
     *
     * @param  the type of argument 2
     * @param  the type of argument 3
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param v argument 3
     * @return a new function {@code (int i, U u) -> void} that calls
     *      {@code f.call(i, u, v)}.
     */
    static  net.mintern.functions.binary.checked.IntObjToNilE
    rbind(IntObjObjToNilE f, V v) {
        return (i, u) -> f.call(i, u, v);
    }

    /**
     * Binds {@code (v)} to the end of {@code this}, returning a new function
     * of type {@code (int, U) -> void}.
     *
     * @param v argument 3
     * @return a new function {@code (int i, U u) -> void} that calls
     *      {@code this.call(i, u, v)}.
     */
    default net.mintern.functions.binary.checked.IntObjToNilE rbind(V v) {
        return IntObjObjToNilE.rbind(this, v);
    }

    /**
     * Binds {@code (i, u, v)} to {@code f}, returning a new function
     * of type {@code () -> void}.
     *
     * @param  the type of argument 2
     * @param  the type of argument 3
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param i argument 1
     * @param u argument 2
     * @param v argument 3
     * @return a new function {@code () -> void} that calls
     *      {@code f.call(i, u, v)}.
     */
    static  net.mintern.functions.nullary.checked.NilToNilE
    bind(IntObjObjToNilE f, int i, U u, V v) {
        return () -> f.call(i, u, v);
    }

    /**
     * Binds {@code (i, u, v)} to {@code this}, returning a new function
     * of type {@code () -> void}.
     *
     * @param i argument 1
     * @param u argument 2
     * @param v argument 3
     * @return a new function {@code () -> void} that calls
     *      {@code this.call(i, u, v)}.
     */
    default net.mintern.functions.nullary.checked.NilToNilE bind(int i, U u, V v) {
        return IntObjObjToNilE.bind(this, i, u, v);
    }
}