org.apache.commons.lang3.function.FailableToDoubleBiFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-lang3 Show documentation

Apache Commons Lang, a package of Java utility classes for the classes that are in java.lang's hierarchy, or are considered to be so standard as to justify existence in java.lang. The code is tested using the latest revision of the JDK for supported LTS releases: 8, 11, 17 and 21 currently. See https://github.com/apache/commons-lang/blob/master/.github/workflows/maven.yml Please ensure your build environment is up-to-date and kindly report any build issues.

There is a newer version: 3.17.0

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.commons.lang3.function;

import java.util.function.ToDoubleBiFunction;

/**
 * A functional interface like {@link ToDoubleBiFunction} that declares a {@link Throwable}.
 *
 * @param  the type of the first argument to the function
 * @param  the type of the second argument to the function
 * @param  The kind of thrown exception or error.
 * @since 3.11
 */
@FunctionalInterface
public interface FailableToDoubleBiFunction {

    /** NOP singleton */
    @SuppressWarnings("rawtypes")
    FailableToDoubleBiFunction NOP = (t, u) -> 0d;

    /**
     * Returns The NOP singleton.
     *
     * @param  the type of the first argument to the function
     * @param  the type of the second argument to the function
     * @param  The kind of thrown exception or error.
     * @return The NOP singleton.
     */
    @SuppressWarnings("unchecked")
    static  FailableToDoubleBiFunction nop() {
        return NOP;
    }

    /**
     * Applies this function to the given arguments.
     *
     * @param t the first function argument
     * @param u the second function argument
     * @return the function result
     * @throws E Thrown when the function fails.
     */
    double applyAsDouble(T t, U u) throws E;
}