io.jsonwebtoken.impl.lang.Functions Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2022 jsonwebtoken.io
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.jsonwebtoken.impl.lang;

import io.jsonwebtoken.lang.Assert;

public final class Functions {

    private Functions() {
    }

    public static  Function identity() {
        return new Function() {
            @Override
            public T apply(T t) {
                return t;
            }
        };
    }

    /**
     * Wraps the specified function to ensure that if any exception occurs, it is of the specified type and/or with
     * the specified message.  If no exception occurs, the function's return value is returned as expected.
     *
     * If {@code fn} throws an exception, its type is checked.  If it is already of type {@code exClass}, that
     * exception is immediately thrown.  If it is not the expected exception type, a message is created with the
     * specified {@code msg} template, and a new exception of the specified type is thrown with the formatted message,
     * using the original exception as its cause.
     *
     * @param fn      the function to execute
     * @param exClass the exception type expected, if any
     * @param msg     the formatted message to use if throwing a new exception, used as the first argument to {@link String#format(String, Object...) String.format}.
     * @param      the function argument type
     * @param      the function's return type
     * @param      type of exception to ensure
     * @return the wrapping function instance.
     */
    public static  Function wrapFmt(CheckedFunction fn, Class exClass, String msg) {
        return new PropagatingExceptionFunction<>(fn, exClass, new FormattedStringFunction(msg));
    }

    public static  Function wrap(Function fn, Class exClass, String fmt, Object... args) {
        return new PropagatingExceptionFunction<>(new DelegatingCheckedFunction<>(fn), exClass, new FormattedStringSupplier(fmt, args));
    }

    /**
     * Returns a composed function that first applies the {@code before} function to its input, and then applies
     * the {@code after} function to the result. If evaluation of either function throws an exception, it is relayed to
     * the caller of the composed function.
     *
     * @param     type of input to the {@code before} function and the resulting composed function.
     * @param     the type of output of the {@code before} function, and of the input to the {@code after} function.
     * @param     return type of the {@code after} function and the resulting composed function.
     * @param before the function to invoke first
     * @param after  the function to invoke second with the output from the first
     * @return a composed function that first applies the {@code before} function and then
     * applies the {@code after} function.
     * @throws IllegalArgumentException if either {@code before} or {@code after} are null.
     */
    public static  Function andThen(final Function before, final Function after) {
        Assert.notNull(before, "Before function cannot be null.");
        Assert.notNull(after, "After function cannot be null.");
        return new Function() {
            @Override
            public R apply(T t) {
                V result = before.apply(t);
                return after.apply(result);
            }
        };
    }

    /**
     * Returns a composed function that invokes the specified functions in iteration order, and returns the first
     * non-null result.  Once a non-null result is discovered, no further functions will be invoked, 'short-circuiting'
     * any remaining functions. If evaluation of any function throws an exception, it is relayed to the caller of the
     * composed function.
     *
     * @param  the type of input of the functions, and of the composed function
     * @param  the type of output of the functions, and of the composed function
     * @param fns the functions to iterate
     * @return a composed function that invokes the specified functions in iteration order, returning the first non-null
     * result.
     * @throws NullPointerException if after is null
     */
    @SafeVarargs
    public static  Function firstResult(final Function... fns) {
        Assert.notEmpty(fns, "Function list cannot be null or empty.");
        return new Function() {
            @Override
            public R apply(T t) {
                for (Function fn : fns) {
                    Assert.notNull(fn, "Function cannot be null.");
                    R result = fn.apply(t);
                    if (result != null) {
                        return result;
                    }
                }
                return null;
            }
        };
    }
}