aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/org/apache/commons/lang3/function/FailableLongPredicate.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/org/apache/commons/lang3/function/FailableLongPredicate.java')
-rw-r--r--src/main/java/org/apache/commons/lang3/function/FailableLongPredicate.java101
1 files changed, 101 insertions, 0 deletions
diff --git a/src/main/java/org/apache/commons/lang3/function/FailableLongPredicate.java b/src/main/java/org/apache/commons/lang3/function/FailableLongPredicate.java
new file mode 100644
index 000000000..426d42891
--- /dev/null
+++ b/src/main/java/org/apache/commons/lang3/function/FailableLongPredicate.java
@@ -0,0 +1,101 @@
+/*
+ * 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.Objects;
+import java.util.function.LongPredicate;
+
+/**
+ * A functional interface like {@link LongPredicate} that declares a {@link Throwable}.
+ *
+ * @param <E> The kind of thrown exception or error.
+ * @since 3.11
+ */
+@FunctionalInterface
+public interface FailableLongPredicate<E extends Throwable> {
+
+ /** FALSE singleton */
+ @SuppressWarnings("rawtypes")
+ FailableLongPredicate FALSE = t -> false;
+
+ /** TRUE singleton */
+ @SuppressWarnings("rawtypes")
+ FailableLongPredicate TRUE = t -> true;
+
+ /**
+ * Returns The FALSE singleton.
+ *
+ * @param <E> The kind of thrown exception or error.
+ * @return The NOP singleton.
+ */
+ static <E extends Throwable> FailableLongPredicate<E> falsePredicate() {
+ return FALSE;
+ }
+
+ /**
+ * Returns The TRUE singleton.
+ *
+ * @param <E> The kind of thrown exception or error.
+ * @return The NOP singleton.
+ */
+ static <E extends Throwable> FailableLongPredicate<E> truePredicate() {
+ return TRUE;
+ }
+
+ /**
+ * Returns a composed {@link FailableLongPredicate} like {@link LongPredicate#and(LongPredicate)}.
+ *
+ * @param other a predicate that will be logically-ANDed with this predicate.
+ * @return a composed {@link FailableLongPredicate} like {@link LongPredicate#and(LongPredicate)}.
+ * @throws NullPointerException if other is null
+ */
+ default FailableLongPredicate<E> and(final FailableLongPredicate<E> other) {
+ Objects.requireNonNull(other);
+ return t -> test(t) && other.test(t);
+ }
+
+ /**
+ * Returns a predicate that negates this predicate.
+ *
+ * @return a predicate that negates this predicate.
+ */
+ default FailableLongPredicate<E> negate() {
+ return t -> !test(t);
+ }
+
+ /**
+ * Returns a composed {@link FailableLongPredicate} like {@link LongPredicate#and(LongPredicate)}.
+ *
+ * @param other a predicate that will be logically-ORed with this predicate.
+ * @return a composed {@link FailableLongPredicate} like {@link LongPredicate#and(LongPredicate)}.
+ * @throws NullPointerException if other is null
+ */
+ default FailableLongPredicate<E> or(final FailableLongPredicate<E> other) {
+ Objects.requireNonNull(other);
+ return t -> test(t) || other.test(t);
+ }
+
+ /**
+ * Tests the predicate.
+ *
+ * @param value the parameter for the predicate to accept.
+ * @return {@code true} if the input argument matches the predicate, {@code false} otherwise.
+ * @throws E Thrown when the consumer fails.
+ */
+ boolean test(long value) throws E;
+}