binary.CharCharToObj 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 (char, char) -> R}.
 *
 * @param  the type of the return value
 */
@FunctionalInterface
public interface CharCharToObj extends
        net.mintern.functions.binary.checked.CharCharToObjE {

    /**
     * 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 the return value
     * @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.CharCharToObjE#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  CharCharToObj unchecked(
            java.util.function.Function toRuntime,
            net.mintern.functions.binary.checked.CharCharToObjE f) {
        return (ch1, ch2) -> {
            try {
                return f.call(ch1, ch2);
            } 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 the return value
     * @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  CharCharToObj unchecked(
            net.mintern.functions.binary.checked.CharCharToObjE 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 the return value
     * @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  CharCharToObj uncheckedIO(
            net.mintern.functions.binary.checked.CharCharToObjE f) {
        return unchecked(java.io.UncheckedIOException::new, f);
    }

    /**
     * Binds {@code (ch1)} to the beginning of {@code f}, returning a new function
     * of type {@code (char) -> R}.
     *
     * @param  the type of the return value
     * @param f the unbound function
     * @param ch1 argument 1
     * @return a new function {@code (char ch2) -> R} that calls
     *      {@code f.call(ch1, ch2)} and returns the result.
     */
    static  net.mintern.functions.unary.CharToObj
    bind(CharCharToObj f, char ch1) {
        return (ch2) -> f.call(ch1, ch2);
    }

    /**
     * Binds {@code (ch1)} to the beginning of {@code this}, returning a new function
     * of type {@code (char) -> R}.
     *
     * @param ch1 argument 1
     * @return a new function {@code (char ch2) -> R} that calls
     *      {@code this.call(ch1, ch2)} and returns the result.
     */
    @Override
    default net.mintern.functions.unary.CharToObj bind(char ch1) {
        return CharCharToObj.bind(this, ch1);
    }

    /**
     * Binds {@code (ch2)} to the end of {@code f}, returning a new function
     * of type {@code (char) -> R}.
     *
     * @param  the type of the return value
     * @param f the unbound function
     * @param ch2 argument 2
     * @return a new function {@code (char ch1) -> R} that calls
     *      {@code f.call(ch1, ch2)} and returns the result.
     */
    static  net.mintern.functions.unary.CharToObj
    rbind(CharCharToObj f, char ch2) {
        return (ch1) -> f.call(ch1, ch2);
    }

    /**
     * Binds {@code (ch2)} to the end of {@code this}, returning a new function
     * of type {@code (char) -> R}.
     *
     * @param ch2 argument 2
     * @return a new function {@code (char ch1) -> R} that calls
     *      {@code this.call(ch1, ch2)} and returns the result.
     */
    @Override
    default net.mintern.functions.unary.CharToObj rbind(char ch2) {
        return CharCharToObj.rbind(this, ch2);
    }

    /**
     * Binds {@code (ch1, ch2)} to {@code f}, returning a new function
     * of type {@code () -> R}.
     *
     * @param  the type of the return value
     * @param f the unbound function
     * @param ch1 argument 1
     * @param ch2 argument 2
     * @return a new function {@code () -> R} that calls
     *      {@code f.call(ch1, ch2)} and returns the result.
     */
    static  net.mintern.functions.nullary.NilToObj
    bind(CharCharToObj f, char ch1, char ch2) {
        return () -> f.call(ch1, ch2);
    }

    /**
     * Binds {@code (ch1, ch2)} to {@code this}, returning a new function
     * of type {@code () -> R}.
     *
     * @param ch1 argument 1
     * @param ch2 argument 2
     * @return a new function {@code () -> R} that calls
     *      {@code this.call(ch1, ch2)} and returns the result.
     */
    @Override
    default net.mintern.functions.nullary.NilToObj bind(char ch1, char ch2) {
        return CharCharToObj.bind(this, ch1, ch2);
    }
}