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.io.UncheckedIOException; 22 import java.util.Objects; 23 import java.util.function.BiConsumer; 24 25 /** 26 * Like {@link BiConsumer} but throws {@link IOException}. 27 * 28 * @param <T> the type of the first argument to the operation 29 * @param <U> the type of the second argument to the operation 30 * 31 * @see BiConsumer 32 * @since 2.12.0 33 */ 34 @FunctionalInterface 35 public interface IOBiConsumer<T, U> { 36 37 /** 38 * Returns the no-op singleton. 39 * 40 * @param <T> the type of the first argument to the operation 41 * @param <U> the type of the second argument to the operation 42 * @return The no-op singleton. 43 */ 44 @SuppressWarnings("unchecked") noop()45 static <T, U> IOBiConsumer<T, U> noop() { 46 return Constants.IO_BI_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 * @throws IOException if an I/O error occurs. 55 */ accept(T t, U u)56 void accept(T t, U u) throws IOException; 57 58 /** 59 * Creates a composed {@link IOBiConsumer} that performs, in sequence, this operation followed by the {@code after} 60 * operation. If performing either operation throws an exception, it is relayed to the caller of the composed operation. 61 * If performing this operation throws an exception, the {@code after} operation will not be performed. 62 * 63 * @param after the operation to perform after this operation 64 * @return a composed {@link IOBiConsumer} that performs in sequence this operation followed by the {@code after} 65 * operation 66 * @throws NullPointerException if {@code after} is null 67 */ andThen(final IOBiConsumer<? super T, ? super U> after)68 default IOBiConsumer<T, U> andThen(final IOBiConsumer<? super T, ? super U> after) { 69 Objects.requireNonNull(after); 70 return (t, u) -> { 71 accept(t, u); 72 after.accept(t, u); 73 }; 74 } 75 76 /** 77 * Creates a {@link BiConsumer} for this instance that throws {@link UncheckedIOException} instead of 78 * {@link IOException}. 79 * 80 * @return an UncheckedIOException BiConsumer. 81 * @throws UncheckedIOException Wraps an {@link IOException}. 82 * @since 2.12.0 83 */ asBiConsumer()84 default BiConsumer<T, U> asBiConsumer() { 85 return (t, u) -> Uncheck.accept(this, t, u); 86 } 87 88 } 89