All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

There is a newer version: 2.0
Show newest version
package net.mintern.functions.ternary;

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

    /**
     * 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.IntObjIntToNilE#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  IntObjIntToNil unchecked(
            java.util.function.Function toRuntime,
            net.mintern.functions.ternary.checked.IntObjIntToNilE f) {
        return (i1, u, i3) -> {
            try {
                f.call(i1, u, i3);
            } 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  IntObjIntToNil unchecked(
            net.mintern.functions.ternary.checked.IntObjIntToNilE 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  IntObjIntToNil uncheckedIO(
            net.mintern.functions.ternary.checked.IntObjIntToNilE f) {
        return unchecked(java.io.UncheckedIOException::new, f);
    }

    /**
     * Binds {@code (i1)} to the beginning of {@code f}, returning a new function
     * of type {@code (U, int) -> void}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param i1 argument 1
     * @return a new function {@code (U u, int i3) -> void} that calls
     *      {@code f.call(i1, u, i3)}.
     */
    static  net.mintern.functions.binary.ObjIntToNil
    bind(IntObjIntToNil f, int i1) {
        return (u, i3) -> f.call(i1, u, i3);
    }

    /**
     * Binds {@code (i1)} to the beginning of {@code this}, returning a new function
     * of type {@code (U, int) -> void}.
     *
     * @param i1 argument 1
     * @return a new function {@code (U u, int i3) -> void} that calls
     *      {@code this.call(i1, u, i3)}.
     */
    @Override
    default net.mintern.functions.binary.ObjIntToNil bind(int i1) {
        return IntObjIntToNil.bind(this, i1);
    }

    /**
     * Binds {@code (u, i3)} to the end of {@code f}, returning a new function
     * of type {@code (int) -> void}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param u argument 2
     * @param i3 argument 3
     * @return a new function {@code (int i1) -> void} that calls
     *      {@code f.call(i1, u, i3)}.
     */
    static  net.mintern.functions.unary.IntToNil
    rbind(IntObjIntToNil f, U u, int i3) {
        return (i1) -> f.call(i1, u, i3);
    }

    /**
     * Binds {@code (u, i3)} to the end of {@code this}, returning a new function
     * of type {@code (int) -> void}.
     *
     * @param u argument 2
     * @param i3 argument 3
     * @return a new function {@code (int i1) -> void} that calls
     *      {@code this.call(i1, u, i3)}.
     */
    @Override
    default net.mintern.functions.unary.IntToNil rbind(U u, int i3) {
        return IntObjIntToNil.rbind(this, u, i3);
    }

    /**
     * Binds {@code (i1, u)} to the beginning of {@code f}, returning a new function
     * of type {@code (int) -> void}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param i1 argument 1
     * @param u argument 2
     * @return a new function {@code (int i3) -> void} that calls
     *      {@code f.call(i1, u, i3)}.
     */
    static  net.mintern.functions.unary.IntToNil
    bind(IntObjIntToNil f, int i1, U u) {
        return (i3) -> f.call(i1, u, i3);
    }

    /**
     * Binds {@code (i1, u)} to the beginning of {@code this}, returning a new function
     * of type {@code (int) -> void}.
     *
     * @param i1 argument 1
     * @param u argument 2
     * @return a new function {@code (int i3) -> void} that calls
     *      {@code this.call(i1, u, i3)}.
     */
    @Override
    default net.mintern.functions.unary.IntToNil bind(int i1, U u) {
        return IntObjIntToNil.bind(this, i1, u);
    }

    /**
     * Binds {@code (i3)} to the end of {@code f}, returning a new function
     * of type {@code (int, U) -> void}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param i3 argument 3
     * @return a new function {@code (int i1, U u) -> void} that calls
     *      {@code f.call(i1, u, i3)}.
     */
    static  net.mintern.functions.binary.IntObjToNil
    rbind(IntObjIntToNil f, int i3) {
        return (i1, u) -> f.call(i1, u, i3);
    }

    /**
     * Binds {@code (i3)} to the end of {@code this}, returning a new function
     * of type {@code (int, U) -> void}.
     *
     * @param i3 argument 3
     * @return a new function {@code (int i1, U u) -> void} that calls
     *      {@code this.call(i1, u, i3)}.
     */
    @Override
    default net.mintern.functions.binary.IntObjToNil rbind(int i3) {
        return IntObjIntToNil.rbind(this, i3);
    }

    /**
     * Binds {@code (i1, u, i3)} to {@code f}, returning a new function
     * of type {@code () -> void}.
     *
     * @param  the type of the argument
     * @param f the unbound function
     * @param i1 argument 1
     * @param u argument 2
     * @param i3 argument 3
     * @return a new function {@code () -> void} that calls
     *      {@code f.call(i1, u, i3)}.
     */
    static  net.mintern.functions.nullary.NilToNil
    bind(IntObjIntToNil f, int i1, U u, int i3) {
        return () -> f.call(i1, u, i3);
    }

    /**
     * Binds {@code (i1, u, i3)} to {@code this}, returning a new function
     * of type {@code () -> void}.
     *
     * @param i1 argument 1
     * @param u argument 2
     * @param i3 argument 3
     * @return a new function {@code () -> void} that calls
     *      {@code this.call(i1, u, i3)}.
     */
    @Override
    default net.mintern.functions.nullary.NilToNil bind(int i1, U u, int i3) {
        return IntObjIntToNil.bind(this, i1, u, i3);
    }
}