org.eu.zajc.ef.bifunction.except.EObjBooleanFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of extended-functions Show documentation

Specializations and support utilities for functional interfaces that are missing from the standard library

The newest version!

// 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.bifunction.except;

import static org.eu.zajc.ef.Utilities.asUnchecked;

import java.util.function.BiFunction;

import org.eu.zajc.ef.bifunction.ObjBooleanFunction;
import org.eu.zajc.ef.function.except.EBooleanFunction;
import org.eu.zajc.ef.trifunction.except.EObjObjBooleanFunction;

/**
 * Represents a function that accepts an object-valued and a {@code boolean}-valued
 * argument, and produces a result. This is the {@code (reference, boolean)}
 * specialization of {@link EBiFunction}.
 *
 * 
 * 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 #applyChecked(Object, boolean)}.
 *
 * @param 
 *            the type of the first argument to the function
 * @param 
 *            the type of the result of the function
 * @param 
 *            {@link Throwable} type
 *
 * @see BiFunction
 * @see EBooleanFunction
 * @see EObjObjBooleanFunction
 *
 * @author Marko Zajc
 */
@FunctionalInterface
public interface EObjBooleanFunction extends ObjBooleanFunction {

	@Override
	default R apply(T t, boolean p) {
		try {
			return applyChecked(t, p);
		} catch (Throwable e) { // NOSONAR can't catch generic exceptions
			throw asUnchecked(e);
		}
	}

	/**
	 * Same as {@link #apply(Object, boolean)}, but throws a checked exception.
	 *
	 * @param t
	 *            the first function argument
	 * @param b
	 *            the second ({@code boolean}) function argument
	 *
	 * @return the function result
	 *
	 * @throws E
	 *             the defined exception type
	 */
	R applyChecked(T t, boolean b) throws E;

}