net.mintern.functions.ternary.LongObjIntToInt 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 (long, U, int) -> int}.
 *
 * @param  the type of the argument
 */
@FunctionalInterface
public interface LongObjIntToInt extends
        net.mintern.functions.ternary.checked.LongObjIntToIntE {

    /**
     * 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 2
     * @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.LongObjIntToIntE#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  LongObjIntToInt unchecked(
            java.util.function.Function toRuntime,
            net.mintern.functions.ternary.checked.LongObjIntToIntE f) {
        return (l, u, i) -> {
            try {
                return f.call(l, u, i);
            } 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 2
     * @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  LongObjIntToInt unchecked(
            net.mintern.functions.ternary.checked.LongObjIntToIntE 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 2
     * @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  LongObjIntToInt uncheckedIO(
            net.mintern.functions.ternary.checked.LongObjIntToIntE f) {
        return unchecked(java.io.UncheckedIOException::new, f);
    }

    /**
     * Binds {@code (l)} to the beginning of {@code f}, returning a new function
     * of type {@code (U, int) -> int}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param l argument 1
     * @return a new function {@code (U u, int i) -> int} that calls
     *      {@code f.call(l, u, i)} and returns the result.
     */
    static  net.mintern.functions.binary.ObjIntToInt
    bind(LongObjIntToInt f, long l) {
        return (u, i) -> f.call(l, u, i);
    }

    /**
     * Binds {@code (l)} to the beginning of {@code this}, returning a new function
     * of type {@code (U, int) -> int}.
     *
     * @param l argument 1
     * @return a new function {@code (U u, int i) -> int} that calls
     *      {@code this.call(l, u, i)} and returns the result.
     */
    @Override
    default net.mintern.functions.binary.ObjIntToInt bind(long l) {
        return LongObjIntToInt.bind(this, l);
    }

    /**
     * Binds {@code (u, i)} to the end of {@code f}, returning a new function
     * of type {@code (long) -> int}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param u argument 2
     * @param i argument 3
     * @return a new function {@code (long l) -> int} that calls
     *      {@code f.call(l, u, i)} and returns the result.
     */
    static  net.mintern.functions.unary.LongToInt
    rbind(LongObjIntToInt f, U u, int i) {
        return (l) -> f.call(l, u, i);
    }

    /**
     * Binds {@code (u, i)} to the end of {@code this}, returning a new function
     * of type {@code (long) -> int}.
     *
     * @param u argument 2
     * @param i argument 3
     * @return a new function {@code (long l) -> int} that calls
     *      {@code this.call(l, u, i)} and returns the result.
     */
    @Override
    default net.mintern.functions.unary.LongToInt rbind(U u, int i) {
        return LongObjIntToInt.rbind(this, u, i);
    }

    /**
     * Binds {@code (l, u)} to the beginning of {@code f}, returning a new function
     * of type {@code (int) -> int}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param l argument 1
     * @param u argument 2
     * @return a new function {@code (int i) -> int} that calls
     *      {@code f.call(l, u, i)} and returns the result.
     */
    static  net.mintern.functions.unary.IntToInt
    bind(LongObjIntToInt f, long l, U u) {
        return (i) -> f.call(l, u, i);
    }

    /**
     * Binds {@code (l, u)} to the beginning of {@code this}, returning a new function
     * of type {@code (int) -> int}.
     *
     * @param l argument 1
     * @param u argument 2
     * @return a new function {@code (int i) -> int} that calls
     *      {@code this.call(l, u, i)} and returns the result.
     */
    @Override
    default net.mintern.functions.unary.IntToInt bind(long l, U u) {
        return LongObjIntToInt.bind(this, l, u);
    }

    /**
     * Binds {@code (i)} to the end of {@code f}, returning a new function
     * of type {@code (long, U) -> int}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param i argument 3
     * @return a new function {@code (long l, U u) -> int} that calls
     *      {@code f.call(l, u, i)} and returns the result.
     */
    static  net.mintern.functions.binary.LongObjToInt
    rbind(LongObjIntToInt f, int i) {
        return (l, u) -> f.call(l, u, i);
    }

    /**
     * Binds {@code (i)} to the end of {@code this}, returning a new function
     * of type {@code (long, U) -> int}.
     *
     * @param i argument 3
     * @return a new function {@code (long l, U u) -> int} that calls
     *      {@code this.call(l, u, i)} and returns the result.
     */
    @Override
    default net.mintern.functions.binary.LongObjToInt rbind(int i) {
        return LongObjIntToInt.rbind(this, i);
    }

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

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