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.LongConsumer;
22
23 /**
24 * A functional interface like {@link LongConsumer} 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 FailableLongConsumer<E extends Throwable> {
31
32 /** NOP singleton */
33 @SuppressWarnings("rawtypes")
34 FailableLongConsumer NOP = t -> { /* NOP */ };
35
36 /**
37 * Returns The NOP singleton.
38 *
39 * @param <E> The kind of thrown exception or error.
40 * @return The NOP singleton.
41 */
42 @SuppressWarnings("unchecked")
43 static <E extends Throwable> FailableLongConsumer<E> nop() {
44 return NOP;
45 }
46
47 /**
48 * Accepts the given arguments.
49 *
50 * @param object the parameter for the consumable to accept
51 * @throws E Thrown when the consumer fails.
52 */
53 void accept(long object) throws E;
54
55 /**
56 * Returns a composed {@link FailableLongConsumer} like {@link LongConsumer#andThen(LongConsumer)}.
57 *
58 * @param after the operation to perform after this one.
59 * @return a composed {@link FailableLongConsumer} like {@link LongConsumer#andThen(LongConsumer)}.
60 * @throws NullPointerException if {@code after} is null
61 */
62 default FailableLongConsumer<E> andThen(final FailableLongConsumer<E> after) {
63 Objects.requireNonNull(after);
64 return (final long t) -> {
65 accept(t);
66 after.accept(t);
67 };
68 }
69 }