1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.lang3.function;
19
20 import java.util.Objects;
21 import java.util.function.LongPredicate;
22
23 /**
24 * A functional interface like {@link LongPredicate} that declares a {@link Throwable}.
25 *
26 * @param <E> The kind of thrown exception or error.
27 * @since 3.11
28 */
29 @FunctionalInterface
30 public interface FailableLongPredicate<E extends Throwable> {
31
32 /** FALSE singleton */
33 @SuppressWarnings("rawtypes")
34 FailableLongPredicate FALSE = t -> false;
35
36 /** TRUE singleton */
37 @SuppressWarnings("rawtypes")
38 FailableLongPredicate TRUE = t -> true;
39
40 /**
41 * Returns The FALSE singleton.
42 *
43 * @param <E> The kind of thrown exception or error.
44 * @return The NOP singleton.
45 */
46 @SuppressWarnings("unchecked")
47 static <E extends Throwable> FailableLongPredicate<E> falsePredicate() {
48 return FALSE;
49 }
50
51 /**
52 * Returns The TRUE singleton.
53 *
54 * @param <E> The kind of thrown exception or error.
55 * @return The NOP singleton.
56 */
57 @SuppressWarnings("unchecked")
58 static <E extends Throwable> FailableLongPredicate<E> truePredicate() {
59 return TRUE;
60 }
61
62 /**
63 * Returns a composed {@link FailableLongPredicate} like {@link LongPredicate#and(LongPredicate)}.
64 *
65 * @param other a predicate that will be logically-ANDed with this predicate.
66 * @return a composed {@link FailableLongPredicate} like {@link LongPredicate#and(LongPredicate)}.
67 * @throws NullPointerException if other is null
68 */
69 default FailableLongPredicate<E> and(final FailableLongPredicate<E> other) {
70 Objects.requireNonNull(other);
71 return t -> test(t) && other.test(t);
72 }
73
74 /**
75 * Returns a predicate that negates this predicate.
76 *
77 * @return a predicate that negates this predicate.
78 */
79 default FailableLongPredicate<E> negate() {
80 return t -> !test(t);
81 }
82
83 /**
84 * Returns a composed {@link FailableLongPredicate} like {@link LongPredicate#and(LongPredicate)}.
85 *
86 * @param other a predicate that will be logically-ORed with this predicate.
87 * @return a composed {@link FailableLongPredicate} like {@link LongPredicate#and(LongPredicate)}.
88 * @throws NullPointerException if other is null
89 */
90 default FailableLongPredicate<E> or(final FailableLongPredicate<E> other) {
91 Objects.requireNonNull(other);
92 return t -> test(t) || other.test(t);
93 }
94
95 /**
96 * Tests the predicate.
97 *
98 * @param value the parameter for the predicate to accept.
99 * @return {@code true} if the input argument matches the predicate, {@code false} otherwise.
100 * @throws E Thrown when the consumer fails.
101 */
102 boolean test(long value) throws E;
103 }