net.mintern.functions.binary.checked.ObjObjToBoolE 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, U) -> boolean}.
 *
 * @param  the type of argument 1
 * @param  the type of argument 2
 * @param  the {@code Exception} type that the operation may throw
 */
@FunctionalInterface
public interface ObjObjToBoolE {

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

    /**
     * Binds {@code (t)} to the beginning of {@code f}, returning a new function
     * of type {@code (U) -> boolean}.
     *
     * @param  the type of argument 1
     * @param  the type of argument 2
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param t argument 1
     * @return a new function {@code (U u) -> boolean} that calls
     *      {@code f.call(t, u)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.ObjToBoolE
    bind(ObjObjToBoolE f, T t) {
        return (u) -> f.call(t, u);
    }

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

    /**
     * Binds {@code (u)} to the end of {@code f}, returning a new function
     * of type {@code (T) -> boolean}.
     *
     * @param  the type of argument 1
     * @param  the type of argument 2
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param u argument 2
     * @return a new function {@code (T t) -> boolean} that calls
     *      {@code f.call(t, u)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.ObjToBoolE
    rbind(ObjObjToBoolE f, U u) {
        return (t) -> f.call(t, u);
    }

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

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

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