net.mintern.functions.ternary.IntIntObjToInt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of functions-ternary-core Show documentation
Provides functional interfaces for the most commonly used two-argument functions
The newest version!
package net.mintern.functions.ternary;

/**
 * An operation of type {@code (int, int, V) -> int}.
 *
 * @param  the type of the argument
 */
@FunctionalInterface
public interface IntIntObjToInt extends
        net.mintern.functions.ternary.checked.IntIntObjToIntE {

    /**
     * Returns a wrapped version of {@code f} that uses {@code toRuntime} to convert any checked
     * {@code Exception} to a {@code RuntimeException}.
     *
     * @param  the type of argument 3
     * @param  the {@code Exception} type that the operation may throw
     * @param toRuntime if a checked exception is thrown from
     *      {@link net.mintern.functions.ternary.checked.IntIntObjToIntE#call}, then this function
     *      is called in in order to convert it to a {@code RuntimeException}
     * @param f the operation to wrap
     * @return a wrapped version of {@code f} that does not throw checked exceptions
     */
    @SuppressWarnings("unchecked")
    static  IntIntObjToInt unchecked(
            java.util.function.Function toRuntime,
            net.mintern.functions.ternary.checked.IntIntObjToIntE f) {
        return (i1, i2, v) -> {
            try {
                return f.call(i1, i2, v);
            } catch (RuntimeException e) {
                throw e;
            } catch (Exception e) {
                throw toRuntime.apply((E) e);
            }
        };
    }

    /**
     * Returns a wrapped version of {@code f} that wraps any checked {@code Exception} with a
     * {@code RuntimeException}.
     *
     * @param  the type of argument 3
     * @param  the {@code Exception} type that the operation may throw
     * @param f the operation to wrap
     * @return a wrapped version of {@code f} that does not throw checked exceptions
     */
    static  IntIntObjToInt unchecked(
            net.mintern.functions.ternary.checked.IntIntObjToIntE f) {
        return unchecked(RuntimeException::new, f);
    }

    /**
     * Returns a wrapped version of {@code f} that wraps any {@code IOException} with an
     * {@link java.io.UncheckedIOException}.
     *
     * @param  the type of argument 3
     * @param  the {@code Exception} type that the operation may throw
     * @param f the operation to wrap
     * @return a wrapped version of {@code f} that throws {@code UncheckedIOException} instead of
     *      {@code IOException}
     */
    static  IntIntObjToInt uncheckedIO(
            net.mintern.functions.ternary.checked.IntIntObjToIntE f) {
        return unchecked(java.io.UncheckedIOException::new, f);
    }

    /**
     * Binds {@code (i1)} to the beginning of {@code f}, returning a new function
     * of type {@code (int, V) -> int}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param i1 argument 1
     * @return a new function {@code (int i2, V v) -> int} that calls
     *      {@code f.call(i1, i2, v)} and returns the result.
     */
    static  net.mintern.functions.binary.IntObjToInt
    bind(IntIntObjToInt f, int i1) {
        return (i2, v) -> f.call(i1, i2, v);
    }

    /**
     * Binds {@code (i1)} to the beginning of {@code this}, returning a new function
     * of type {@code (int, V) -> int}.
     *
     * @param i1 argument 1
     * @return a new function {@code (int i2, V v) -> int} that calls
     *      {@code this.call(i1, i2, v)} and returns the result.
     */
    @Override
    default net.mintern.functions.binary.IntObjToInt bind(int i1) {
        return IntIntObjToInt.bind(this, i1);
    }

    /**
     * Binds {@code (i2, v)} to the end of {@code f}, returning a new function
     * of type {@code (int) -> int}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param i2 argument 2
     * @param v argument 3
     * @return a new function {@code (int i1) -> int} that calls
     *      {@code f.call(i1, i2, v)} and returns the result.
     */
    static  net.mintern.functions.unary.IntToInt
    rbind(IntIntObjToInt f, int i2, V v) {
        return (i1) -> f.call(i1, i2, v);
    }

    /**
     * Binds {@code (i2, v)} to the end of {@code this}, returning a new function
     * of type {@code (int) -> int}.
     *
     * @param i2 argument 2
     * @param v argument 3
     * @return a new function {@code (int i1) -> int} that calls
     *      {@code this.call(i1, i2, v)} and returns the result.
     */
    @Override
    default net.mintern.functions.unary.IntToInt rbind(int i2, V v) {
        return IntIntObjToInt.rbind(this, i2, v);
    }

    /**
     * Binds {@code (i1, i2)} to the beginning of {@code f}, returning a new function
     * of type {@code (V) -> int}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param i1 argument 1
     * @param i2 argument 2
     * @return a new function {@code (V v) -> int} that calls
     *      {@code f.call(i1, i2, v)} and returns the result.
     */
    static  net.mintern.functions.unary.ObjToInt
    bind(IntIntObjToInt f, int i1, int i2) {
        return (v) -> f.call(i1, i2, v);
    }

    /**
     * Binds {@code (i1, i2)} to the beginning of {@code this}, returning a new function
     * of type {@code (V) -> int}.
     *
     * @param i1 argument 1
     * @param i2 argument 2
     * @return a new function {@code (V v) -> int} that calls
     *      {@code this.call(i1, i2, v)} and returns the result.
     */
    @Override
    default net.mintern.functions.unary.ObjToInt bind(int i1, int i2) {
        return IntIntObjToInt.bind(this, i1, i2);
    }

    /**
     * Binds {@code (v)} to the end of {@code f}, returning a new function
     * of type {@code (int, int) -> int}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param v argument 3
     * @return a new function {@code (int i1, int i2) -> int} that calls
     *      {@code f.call(i1, i2, v)} and returns the result.
     */
    static  net.mintern.functions.binary.IntIntToInt
    rbind(IntIntObjToInt f, V v) {
        return (i1, i2) -> f.call(i1, i2, v);
    }

    /**
     * Binds {@code (v)} to the end of {@code this}, returning a new function
     * of type {@code (int, int) -> int}.
     *
     * @param v argument 3
     * @return a new function {@code (int i1, int i2) -> int} that calls
     *      {@code this.call(i1, i2, v)} and returns the result.
     */
    @Override
    default net.mintern.functions.binary.IntIntToInt rbind(V v) {
        return IntIntObjToInt.rbind(this, v);
    }

    /**
     * Binds {@code (i1, i2, v)} to {@code f}, returning a new function
     * of type {@code () -> int}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param i1 argument 1
     * @param i2 argument 2
     * @param v argument 3
     * @return a new function {@code () -> int} that calls
     *      {@code f.call(i1, i2, v)} and returns the result.
     */
    static  net.mintern.functions.nullary.NilToInt
    bind(IntIntObjToInt f, int i1, int i2, V v) {
        return () -> f.call(i1, i2, v);
    }

    /**
     * Binds {@code (i1, i2, v)} to {@code this}, returning a new function
     * of type {@code () -> int}.
     *
     * @param i1 argument 1
     * @param i2 argument 2
     * @param v argument 3
     * @return a new function {@code () -> int} that calls
     *      {@code this.call(i1, i2, v)} and returns the result.
     */
    @Override
    default net.mintern.functions.nullary.NilToInt bind(int i1, int i2, V v) {
        return IntIntObjToInt.bind(this, i1, i2, v);
    }
}