org.eu.zajc.ef.biconsumer.except.EBiConsumer Maven / Gradle / Ivy
Show all versions of extended-functions Show documentation
// SPDX-License-Identifier: Apache-2.0
/*
* extended-functions
* Copyright 2021-2024 Marko Zajc
*
* Licensed 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.eu.zajc.ef.biconsumer.except;
import static org.eu.zajc.ef.Utilities.asUnchecked;
import java.util.function.BiConsumer;
import org.eu.zajc.ef.consumer.execpt.EConsumer;
import org.eu.zajc.ef.triconsumer.except.ETriConsumer;
/**
* Represents an operation that accepts two input arguments and returns no result.
* This is the two-arity specialization of {@link EConsumer}. Unlike most other
* functional interfaces, {@link EBiConsumer} is expected to operate via
* side-effects.
*
*
* Additionally, the functional method is allowed to throw a generic
* {@link Throwable} of type {@code E}.
*
*
* This is a functional interface whose functional method is
* {@link #acceptChecked(Object, Object)}.
*
* @param
* the type of the first argument to the operation
* @param
* the type of the second argument to the operation
* @param
* {@link Throwable} type
*
* @see BiConsumer
* @see EConsumer
* @see ETriConsumer
*
* @author Marko Zajc
*/
@FunctionalInterface
public interface EBiConsumer extends BiConsumer {
@Override
default void accept(T t, U u) {
try {
acceptChecked(t, u);
} catch (Throwable e) { // NOSONAR can't catch generic exceptions
throw asUnchecked(e);
}
}
/**
* Same as {@link #accept(Object, Object)}, but throws a checked exception.
*
* @param t
* the first input argument
* @param u
* the second input argument
*
* @throws E
* the defined exception type
*/
void acceptChecked(T t, U u) throws E;
}