diff options
Diffstat (limited to 'src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java')
-rw-r--r-- | src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java b/src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java new file mode 100644 index 000000000..3c0d5f7ed --- /dev/null +++ b/src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java @@ -0,0 +1,58 @@ +/* + * 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.ToLongBiFunction; + +/** + * A functional interface like {@link ToLongBiFunction} that declares a {@link Throwable}. + * + * @param <T> the type of the first argument to the function + * @param <U> the type of the second argument to the function + * @param <E> The kind of thrown exception or error. + * @since 3.11 + */ +@FunctionalInterface +public interface FailableToLongBiFunction<T, U, E extends Throwable> { + + /** NOP singleton */ + @SuppressWarnings("rawtypes") + FailableToLongBiFunction NOP = (t, u) -> 0; + + /** + * Returns The NOP singleton. + * + * @param <T> the type of the first argument to the function + * @param <U> the type of the second argument to the function + * @param <E> The kind of thrown exception or error. + * @return The NOP singleton. + */ + static <T, U, E extends Throwable> FailableToLongBiFunction<T, U, E> 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. + */ + long applyAsLong(T t, U u) throws E; +} |