net.mintern.functions.binary.checked.ObjIntToObjE Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of functions-binary-core Show documentation
Provides functional interfaces for the most commonly used two-argument functions
The newest version!
package net.mintern.functions.binary.checked;

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

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

    /**
     * Binds {@code (t)} 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 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 (int i) -> R} that calls
     *      {@code f.call(t, i)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.IntToObjE
    bind(ObjIntToObjE f, T t) {
        return (i) -> f.call(t, i);
    }

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

    /**
     * Binds {@code (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 the return value
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param i argument 2
     * @return a new function {@code (T t) -> R} that calls
     *      {@code f.call(t, i)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.ObjToObjE
    rbind(ObjIntToObjE f, int i) {
        return (t) -> f.call(t, i);
    }

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

    /**
     * Binds {@code (t, i)} to {@code f}, returning a new function
     * of type {@code () -> R}.
     *
     * @param  the type of argument 1
     * @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 i argument 2
     * @return a new function {@code () -> R} that calls
     *      {@code f.call(t, 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(ObjIntToObjE f, T t, int i) {
        return () -> f.call(t, i);
    }

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