binary.ObjObjToFloat 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;

/**
 * An operation of type {@code (T, U) -> float}.
 *
 * @param  the type of argument 1
 * @param  the type of argument 2
 */
@FunctionalInterface
public interface ObjObjToFloat extends
        net.mintern.functions.binary.checked.ObjObjToFloatE {

    /**
     * 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 1
     * @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.binary.checked.ObjObjToFloatE#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  ObjObjToFloat unchecked(
            java.util.function.Function toRuntime,
            net.mintern.functions.binary.checked.ObjObjToFloatE f) {
        return (t, u) -> {
            try {
                return f.call(t, u);
            } 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 1
     * @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  ObjObjToFloat unchecked(
            net.mintern.functions.binary.checked.ObjObjToFloatE 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 1
     * @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  ObjObjToFloat uncheckedIO(
            net.mintern.functions.binary.checked.ObjObjToFloatE f) {
        return unchecked(java.io.UncheckedIOException::new, f);
    }

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

    /**
     * Binds {@code (t)} to the beginning of {@code this}, returning a new function
     * of type {@code (U) -> float}.
     *
     * @param t argument 1
     * @return a new function {@code (U u) -> float} that calls
     *      {@code this.call(t, u)} and returns the result.
     */
    @Override
    default net.mintern.functions.unary.ObjToFloat bind(T t) {
        return ObjObjToFloat.bind(this, t);
    }

    /**
     * Binds {@code (u)} to the end of {@code f}, returning a new function
     * of type {@code (T) -> float}.
     *
     * @param  the type of argument 1
     * @param  the type of argument 2
     * @param f the unbound function
     * @param u argument 2
     * @return a new function {@code (T t) -> float} that calls
     *      {@code f.call(t, u)} and returns the result.
     */
    static  net.mintern.functions.unary.ObjToFloat
    rbind(ObjObjToFloat f, U u) {
        return (t) -> f.call(t, u);
    }

    /**
     * Binds {@code (u)} to the end of {@code this}, returning a new function
     * of type {@code (T) -> float}.
     *
     * @param u argument 2
     * @return a new function {@code (T t) -> float} that calls
     *      {@code this.call(t, u)} and returns the result.
     */
    @Override
    default net.mintern.functions.unary.ObjToFloat rbind(U u) {
        return ObjObjToFloat.rbind(this, u);
    }

    /**
     * Binds {@code (t, u)} to {@code f}, returning a new function
     * of type {@code () -> float}.
     *
     * @param  the type of argument 1
     * @param  the type of argument 2
     * @param f the unbound function
     * @param t argument 1
     * @param u argument 2
     * @return a new function {@code () -> float} that calls
     *      {@code f.call(t, u)} and returns the result.
     */
    static  net.mintern.functions.nullary.NilToFloat
    bind(ObjObjToFloat f, T t, U u) {
        return () -> f.call(t, u);
    }

    /**
     * Binds {@code (t, u)} to {@code this}, returning a new function
     * of type {@code () -> float}.
     *
     * @param t argument 1
     * @param u argument 2
     * @return a new function {@code () -> float} that calls
     *      {@code this.call(t, u)} and returns the result.
     */
    @Override
    default net.mintern.functions.nullary.NilToFloat bind(T t, U u) {
        return ObjObjToFloat.bind(this, t, u);
    }
}