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

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

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

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

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

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

    /**
     * Binds {@code (i, b)} 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 i argument 1
     * @param b argument 2
     * @return a new function {@code () -> int} that calls
     *      {@code f.call(i, b)} and returns the result.
     */
    static  net.mintern.functions.nullary.checked.NilToIntE
    bind(IntByteToIntE f, int i, byte b) {
        return () -> f.call(i, b);
    }

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