com.github.tadukoo.util.functional.function.ThrowingFunction2 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of TadukooFunctions Show documentation

There is a newer version: 0.6.1-Beta

package com.github.tadukoo.util.functional.function;

import java.util.function.BiFunction;

/**
 * A better version of Java's {@link BiFunction} interface that 
 * allows for the functions to throw whatever {@link Throwable} is
 * specified.
 *
 * @param  The 1st input argument type for the function
 * @param  The 2nd input argument type for the function
 * @param  The output result type for the function
 * @param  The type of {@link Throwable} thrown by the function
 * 
 * @author Logan Ferree (Tadukoo)
 * @version 0.1-Alpha-SNAPSHOT
 */
@FunctionalInterface
public interface ThrowingFunction2{
	
	/**
	 * Takes two arguments and returns a result.
	 * 
	 * @param a The 1st argument
	 * @param b The 2nd argument
	 * @return R result
	 * @throws T Determined by the function, not required
	 */
	R apply(A a, B b) throws T;
	
	/**
	 * Creates a ThrowingFunction2 that runs this ThrowingFunction2 and 
	 * puts the result into the given {@link ThrowingFunction}.
	 * 
	 * @param  The output type of the {@link ThrowingFunction}
	 * @param after A {@link ThrowingFunction} to put the result of this ThrowingFunction2 into
	 * @return The ThrowingFunction2 made from composing this one and the given {@link ThrowingFunction}
	 */
	default  ThrowingFunction2 andThen(ThrowingFunction after){
		return (a, b) -> after.apply(this.apply(a, b));
	}
}