aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java
diff options
context:
space:
mode:
authorAndrew Vuong <akvuong@google.com>2023-02-14 20:41:37 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>2023-02-14 20:41:37 +0000
commit47d7817e55fb09b92eb16823f57ba6f03cea5486 (patch)
tree8e1380b130c548b03135010a952574030e77ada9 /src/main/java/org/apache/commons/lang3/function/FailableToLongBiFunction.java
parent2a77099c93be7bbf4d56b677d968bfca258b558f (diff)
parenta44dd5043caffbb854707d37bc0c2f0d3b994d83 (diff)
downloadapache-commons-lang-47d7817e55fb09b92eb16823f57ba6f03cea5486.tar.gz
Initial import of apache-commons-lang from upstream master am: ff344be6c0 am: a44dd5043c
Original change: https://android-review.googlesource.com/c/platform/external/apache-commons-lang/+/2434253 Change-Id: If961374cebabfe877f03f6f9fea997a374d685e6 Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
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.java58
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;
+}