binary.checked.BoolBoolToIntE Maven / Gradle / Ivy

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

/**
 * An operation of type {@code (boolean, boolean) -> int}.
 *
 * @param  the {@code Exception} type that the operation may throw
 */
@FunctionalInterface
public interface BoolBoolToIntE {

    /**
     * Performs this operation.
     *
     * @param bool1 argument 1
     * @param bool2 argument 2
     * @return the result of the operation
     * @throws E if the operation cannot be completed
     */
    int call(boolean bool1, boolean bool2) throws E;

    /**
     * Binds {@code (bool1)} to the beginning of {@code f}, returning a new function
     * of type {@code (boolean) -> int}.
     *
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param bool1 argument 1
     * @return a new function {@code (boolean bool2) -> int} that calls
     *      {@code f.call(bool1, bool2)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.BoolToIntE
    bind(BoolBoolToIntE f, boolean bool1) {
        return (bool2) -> f.call(bool1, bool2);
    }

    /**
     * Binds {@code (bool1)} to the beginning of {@code this}, returning a new function
     * of type {@code (boolean) -> int}.
     *
     * @param bool1 argument 1
     * @return a new function {@code (boolean bool2) -> int} that calls
     *      {@code this.call(bool1, bool2)} and returns the result.
     */
    default net.mintern.functions.unary.checked.BoolToIntE bind(boolean bool1) {
        return BoolBoolToIntE.bind(this, bool1);
    }

    /**
     * Binds {@code (bool2)} to the end of {@code f}, returning a new function
     * of type {@code (boolean) -> int}.
     *
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param bool2 argument 2
     * @return a new function {@code (boolean bool1) -> int} that calls
     *      {@code f.call(bool1, bool2)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.BoolToIntE
    rbind(BoolBoolToIntE f, boolean bool2) {
        return (bool1) -> f.call(bool1, bool2);
    }

    /**
     * Binds {@code (bool2)} to the end of {@code this}, returning a new function
     * of type {@code (boolean) -> int}.
     *
     * @param bool2 argument 2
     * @return a new function {@code (boolean bool1) -> int} that calls
     *      {@code this.call(bool1, bool2)} and returns the result.
     */
    default net.mintern.functions.unary.checked.BoolToIntE rbind(boolean bool2) {
        return BoolBoolToIntE.rbind(this, bool2);
    }

    /**
     * Binds {@code (bool1, bool2)} to {@code f}, returning a new function
     * of type {@code () -> int}.
     *
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param bool1 argument 1
     * @param bool2 argument 2
     * @return a new function {@code () -> int} that calls
     *      {@code f.call(bool1, bool2)} and returns the result.
     */
    static  net.mintern.functions.nullary.checked.NilToIntE
    bind(BoolBoolToIntE f, boolean bool1, boolean bool2) {
        return () -> f.call(bool1, bool2);
    }

    /**
     * Binds {@code (bool1, bool2)} to {@code this}, returning a new function
     * of type {@code () -> int}.
     *
     * @param bool1 argument 1
     * @param bool2 argument 2
     * @return a new function {@code () -> int} that calls
     *      {@code this.call(bool1, bool2)} and returns the result.
     */
    default net.mintern.functions.nullary.checked.NilToIntE bind(boolean bool1, boolean bool2) {
        return BoolBoolToIntE.bind(this, bool1, bool2);
    }
}