binary.ObjBoolToFloat 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, boolean) -> float}.
 *
 * @param  the type of the argument
 */
@FunctionalInterface
public interface ObjBoolToFloat extends
        net.mintern.functions.binary.checked.ObjBoolToFloatE {

    /**
     * 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 {@code Exception} type that the operation may throw
     * @param toRuntime if a checked exception is thrown from
     *      {@link net.mintern.functions.binary.checked.ObjBoolToFloatE#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  ObjBoolToFloat unchecked(
            java.util.function.Function toRuntime,
            net.mintern.functions.binary.checked.ObjBoolToFloatE f) {
        return (t, bool) -> {
            try {
                return f.call(t, bool);
            } 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 {@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  ObjBoolToFloat unchecked(
            net.mintern.functions.binary.checked.ObjBoolToFloatE 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 {@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  ObjBoolToFloat uncheckedIO(
            net.mintern.functions.binary.checked.ObjBoolToFloatE f) {
        return unchecked(java.io.UncheckedIOException::new, f);
    }

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

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

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

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

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

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