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

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

    /**
     * Binds {@code (ch)} to the beginning of {@code f}, returning a new function
     * of type {@code (int) -> R}.
     *
     * @param  the type of the return value
     * @param  the {@code Exception} type that the operation may throw
     * @param f the unbound function
     * @param ch argument 1
     * @return a new function {@code (int i) -> R} that calls
     *      {@code f.call(ch, i)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.IntToObjE
    bind(CharIntToObjE f, char ch) {
        return (i) -> f.call(ch, i);
    }

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

    /**
     * Binds {@code (i)} to the end of {@code f}, returning a new function
     * of type {@code (char) -> R}.
     *
     * @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 (char ch) -> R} that calls
     *      {@code f.call(ch, i)} and returns the result.
     */
    static  net.mintern.functions.unary.checked.CharToObjE
    rbind(CharIntToObjE f, int i) {
        return (ch) -> f.call(ch, i);
    }

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

    /**
     * Binds {@code (ch, i)} 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 ch argument 1
     * @param i argument 2
     * @return a new function {@code () -> R} that calls
     *      {@code f.call(ch, 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(CharIntToObjE f, char ch, int i) {
        return () -> f.call(ch, i);
    }

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