com.github.tadukoo.util.functional.predicate.ThrowingPredicate3 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.predicate;

/**
 * A predicate that takes three arguments, returns a boolean, 
 * and may throw a {@link Throwable}.
 *
 * @param  The 1st input argument type for the predicate
 * @param  The 2nd input argument type for the predicate
 * @param  The 3rd input argument type for the predicate
 * @param  The type of {@link Throwable} thrown by the predicate
 * 
 * @author Logan Ferree (Tadukoo)
 * @version 0.1-Alpha-SNAPSHOT
 */
@FunctionalInterface
public interface ThrowingPredicate3{
	
	/**
	 * Takes three arguments and returns a boolean.
	 * 
	 * @param a The 1st argument
	 * @param b The 2nd argument
	 * @param c The 3rd argument
	 * @return A boolean
	 * @throws T Determined by the predicate, not required
	 */
	boolean test(A a, B b, C c) throws T;
	
	/**
	 * Creates a ThrowingPredicate3 that will test the arguments with this ThrowingPredicate3 
	 * and with the given ThrowingPredicate3, returning true only if both results are true.
	 * 
	 * @param other The other ThrowingPredicate3 to test the arguments on
	 * @return The ThrowingPredicate3 that results from composing this one and the given one
	 */
	default ThrowingPredicate3 and(ThrowingPredicate3 other){
		return (a, b, c) -> this.test(a, b, c) && other.test(a, b, c);
	}
	
	/**
	 * Creates a ThrowingPredicate3 that will test the arguments with this ThrowingPredicate3 
	 * and with the given ThrowingPredicate3, returning true if either result is true.
	 * 
	 * @param other The other ThrowingPredicate3 to test the arguments on
	 * @return The ThrowingPredicate3 that results from composing this one and the given one
	 */
	default ThrowingPredicate3 or(ThrowingPredicate3 other){
		return (a, b, c) -> this.test(a, b, c) || other.test(a, b, c);
	}
	
	/**
	 * Creates a ThrowingPredicate3 that will return the opposite result of this ThrowingPredicate3.
	 * 
	 * @return A negated version of this ThrowingPredicate3
	 */
	default ThrowingPredicate3 negate(){
		return (a, b, c) -> !this.test(a, b, c);
	}
}