com.swirlds.base.function.CheckedFunction Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of swirlds-base Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.54.0

Show newest version

/*
 * Copyright (C) 2023-2024 Hedera Hashgraph, LLC
 *
 * 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 com.swirlds.base.function;

import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;
import java.util.Objects;
import java.util.function.Function;

/**
 * Similar to {@link java.util.function.Function} but throws an exception.
 *
 * @param  the type accepted by the function
 * @param  the return type of the function
 * @param  the type thrown by the function
 */
@FunctionalInterface
public interface CheckedFunction {

    /**
     * Apply the function.
     *
     * @param value the input to the function
     * @return the value returned by the function
     * @throws E the exception type thrown by the function
     */
    @Nullable
    R apply(@Nullable T value) throws E;

    /**
     * Convert a {@link Function} to a {@link CheckedFunction}.
     *
     * @param function the function
     * @param       the type accepted by the function
     * @param       the return type of the function
     * @param       the type thrown by the function
     * @return the {@link CheckedFunction}
     */
    @NonNull
    static  CheckedFunction of(@NonNull final Function function) {
        Objects.requireNonNull(function, "function must not be null");
        return function::apply;
    }
}