binary.checked.BoolBoolToObjE 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) -> R}.
 *
 * @param  the type of the return value
 * @param  the {@code Exception} type that the operation may throw
 */
@FunctionalInterface
public interface BoolBoolToObjE {

    /**
     * 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
     */
    R call(boolean bool1, boolean bool2) throws E;

    /**
     * Binds {@code (bool1)} to the beginning of {@code f}, returning a new function
     * of type {@code (boolean) -> R}.
     *
     * @param  the type of the return value
     * @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) -> R} that calls
     *      {@code f.call(bool1, bool2)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.BoolToObjE
    bind(BoolBoolToObjE 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) -> R}.
     *
     * @param bool1 argument 1
     * @return a new function {@code (boolean bool2) -> R} that calls
     *      {@code this.call(bool1, bool2)} and returns the result.
     */
    default net.mintern.functions.unary.checked.BoolToObjE bind(boolean bool1) {
        return BoolBoolToObjE.bind(this, bool1);
    }

    /**
     * Binds {@code (bool2)} to the end of {@code f}, returning a new function
     * of type {@code (boolean) -> R}.
     *
     * @param  the type of the return value
     * @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) -> R} that calls
     *      {@code f.call(bool1, bool2)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.BoolToObjE
    rbind(BoolBoolToObjE 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) -> R}.
     *
     * @param bool2 argument 2
     * @return a new function {@code (boolean bool1) -> R} that calls
     *      {@code this.call(bool1, bool2)} and returns the result.
     */
    default net.mintern.functions.unary.checked.BoolToObjE rbind(boolean bool2) {
        return BoolBoolToObjE.rbind(this, bool2);
    }

    /**
     * Binds {@code (bool1, bool2)} to {@code f}, returning a new function
     * of type {@code () -> R}.
     *
     * @param  the type of the return value
     * @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 () -> R} that calls
     *      {@code f.call(bool1, bool2)} and returns the result.
     */
    @SuppressWarnings("unchecked") // maven spuriously warns about a type error in this case
    static  net.mintern.functions.nullary.checked.NilToObjE
    bind(BoolBoolToObjE f, boolean bool1, boolean bool2) {
        return () -> f.call(bool1, bool2);
    }

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