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.io.function;
19
20 import java.io.IOException;
21 import java.util.Objects;
22 import java.util.function.BiConsumer;
23
24 /**
25 * Like {@link BiConsumer} but throws {@link IOException}.
26 *
27 * @param <T> the type of the first argument to the operation
28 * @param <U> the type of the second argument to the operation
29 * @param <V> the type of the third argument to the operation
30 * @see BiConsumer
31 * @since 2.12.0
32 */
33 @FunctionalInterface
34 public interface IOTriConsumer<T, U, V> {
35
36 /**
37 * Returns the no-op singleton.
38 *
39 * @param <T> the type of the first argument to the operation
40 * @param <U> the type of the second argument to the operation
41 * @param <V> the type of the third argument to the operation
42 * @return The no-op singleton.
43 */
44 @SuppressWarnings("unchecked")
45 static <T, U, V> IOTriConsumer<T, U, V> noop() {
46 return Constants.IO_TRI_CONSUMER;
47 }
48
49 /**
50 * Performs this operation on the given arguments.
51 *
52 * @param t the first input argument
53 * @param u the second input argument
54 * @param v the second third argument
55 * @throws IOException if an I/O error occurs.
56 */
57 void accept(T t, U u, V v) throws IOException;
58
59 /**
60 * Creates a composed {@link IOTriConsumer} that performs, in sequence, this operation followed by the {@code after}
61 * operation. If performing either operation throws an exception, it is relayed to the caller of the composed operation.
62 * If performing this operation throws an exception, the {@code after} operation will not be performed.
63 *
64 * @param after the operation to perform after this operation
65 * @return a composed {@link IOTriConsumer} that performs in sequence this operation followed by the {@code after}
66 * operation
67 * @throws NullPointerException if {@code after} is null
68 */
69 default IOTriConsumer<T, U, V> andThen(final IOTriConsumer<? super T, ? super U, ? super V> after) {
70 Objects.requireNonNull(after);
71 return (t, u, v) -> {
72 accept(t, u, v);
73 after.accept(t, u, v);
74 };
75 }
76 }