binary.IntCharToChar 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 (int, char) -> char}.
 *
 */
@FunctionalInterface
public interface IntCharToChar extends
        net.mintern.functions.binary.checked.IntCharToCharE {

    /**
     * Returns a wrapped version of {@code f} that uses {@code toRuntime} to convert any checked
     * {@code Exception} to a {@code RuntimeException}.
     *
     * @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.IntCharToCharE#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  IntCharToChar unchecked(
            java.util.function.Function toRuntime,
            net.mintern.functions.binary.checked.IntCharToCharE f) {
        return (i, ch) -> {
            try {
                return f.call(i, ch);
            } 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 {@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  IntCharToChar unchecked(
            net.mintern.functions.binary.checked.IntCharToCharE 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 {@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  IntCharToChar uncheckedIO(
            net.mintern.functions.binary.checked.IntCharToCharE f) {
        return unchecked(java.io.UncheckedIOException::new, f);
    }

    /**
     * Binds {@code (i)} to the beginning of {@code f}, returning a new function
     * of type {@code (char) -> char}.
     *
     * @param f the unbound function
     * @param i argument 1
     * @return a new function {@code (char ch) -> char} that calls
     *      {@code f.call(i, ch)} and returns the result.
     */
    static  net.mintern.functions.unary.CharToChar
    bind(IntCharToChar f, int i) {
        return (ch) -> f.call(i, ch);
    }

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

    /**
     * Binds {@code (ch)} to the end of {@code f}, returning a new function
     * of type {@code (int) -> char}.
     *
     * @param f the unbound function
     * @param ch argument 2
     * @return a new function {@code (int i) -> char} that calls
     *      {@code f.call(i, ch)} and returns the result.
     */
    static  net.mintern.functions.unary.IntToChar
    rbind(IntCharToChar f, char ch) {
        return (i) -> f.call(i, ch);
    }

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

    /**
     * Binds {@code (i, ch)} to {@code f}, returning a new function
     * of type {@code () -> char}.
     *
     * @param f the unbound function
     * @param i argument 1
     * @param ch argument 2
     * @return a new function {@code () -> char} that calls
     *      {@code f.call(i, ch)} and returns the result.
     */
    static  net.mintern.functions.nullary.NilToChar
    bind(IntCharToChar f, int i, char ch) {
        return () -> f.call(i, ch);
    }

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