binary.checked.ObjBoolToObjE 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 (T, boolean) -> 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 ObjBoolToObjE {

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

    /**
     * Binds {@code (t)} to the beginning of {@code f}, returning a new function
     * of type {@code (boolean) -> 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 (boolean bool) -> R} that calls
     *      {@code f.call(t, bool)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.BoolToObjE
    bind(ObjBoolToObjE f, T t) {
        return (bool) -> f.call(t, bool);
    }

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

    /**
     * Binds {@code (bool)} 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 bool argument 2
     * @return a new function {@code (T t) -> R} that calls
     *      {@code f.call(t, bool)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.ObjToObjE
    rbind(ObjBoolToObjE f, boolean bool) {
        return (t) -> f.call(t, bool);
    }

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

    /**
     * Binds {@code (t, bool)} 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 bool argument 2
     * @return a new function {@code () -> R} that calls
     *      {@code f.call(t, bool)} and returns the result.
     */
    @SuppressWarnings("unchecked") // maven spuriously warns about a type error in this case
    static  net.mintern.functions.nullary.checked.NilToObjE
    bind(ObjBoolToObjE f, T t, boolean bool) {
        return () -> f.call(t, bool);
    }

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