All Downloads are FREE. Search and download functionalities are using the official Maven repository.

eu.lunisolar.magma.func.predicate.LBytePredicateX Maven / Gradle / Ivy

There is a newer version: 3.0.0
Show newest version
/*
 * This file is part of "lunisolar-magma".
 *
 * (C) Copyright 2015 Lunisolar (http://lunisolar.eu/).
 *
 * 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 eu.lunisolar.magma.func.predicate;
import javax.annotation.Nonnull; // NOSONAR
import javax.annotation.Nullable; // NOSONAR
import java.util.Comparator; // NOSONAR
import java.util.Objects; // NOSONAR
import eu.lunisolar.magma.basics.*; //NOSONAR
import eu.lunisolar.magma.basics.builder.*; // NOSONAR
import eu.lunisolar.magma.basics.exceptions.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.functional.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.functional.type.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.functional.domain.*; // NOSONAR
import eu.lunisolar.magma.func.*; // NOSONAR
import eu.lunisolar.magma.func.operator.unary.*; // NOSONAR
import eu.lunisolar.magma.func.operator.binary.*; // NOSONAR
import eu.lunisolar.magma.func.operator.ternary.*; // NOSONAR
import eu.lunisolar.magma.func.function.*; // NOSONAR
import eu.lunisolar.magma.func.function.from.*; // NOSONAR
import eu.lunisolar.magma.func.function.to.*; // NOSONAR
import eu.lunisolar.magma.func.function.conversion.*; // NOSONAR
import eu.lunisolar.magma.func.predicate.*; // NOSONAR
import eu.lunisolar.magma.func.supplier.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.bi.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.tri.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.obj.*; // NOSONAR
import eu.lunisolar.magma.func.action.*; // NOSONAR

/**
 * Throwing functional interface (lambda) LBytePredicateX for Java 8.
 *
 * Type: predicate
 *
 * Domain (lvl: 1): byte b
 *
 * Co-domain: none
 *
 * @see LBytePredicate
 */
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LBytePredicateX extends MetaPredicate, PrimitiveCodomain, MetaInterface.Throwing { // NOSONAR

	static final String DESCRIPTION = "LBytePredicateX: boolean doTest(byte b) throws X";

	boolean doTest(byte b) throws X;

	/** Function call that handles exceptions by always nesting checked exceptions and propagating the otheres as is. */
	default boolean nestingDoTest(byte b) {
		try {
			return this.doTest(b);
		} catch (RuntimeException | Error e) { // NOSONAR
			throw e;
		} catch (Throwable e) { // NOSONAR
			throw new NestedException(e);
		}
	}

	/** Function call that handles exceptions by always propagating them as is even when they are undeclared checked ones. */
	default boolean shovingDoTest(byte b) {
		return ((LBytePredicateX) this).doTest(b);
	}

	/** Function call that handles exceptions according to the instructions. */
	default  boolean handlingDoTest(byte b, HandlingInstructions handling) throws Y {

		try {
			return this.doTest(b);
		} catch (Throwable e) { // NOSONAR
			throw Handler.handleOrNest(e, handling);
		}
	}

	/** Just to mirror the method: Ensures the result is not null */
	default boolean nonNullDoTest(byte b) throws X {
		return doTest(b);
	}

	/** For convenience, where "test()" makes things more confusing than "applyAsBoolean()". */

	default boolean doApplyAsBoolean(byte b) throws X {
		return doTest(b);
	}

	/** Returns description of the functional interface. */
	@Nonnull
	default String functionalInterfaceDescription() {
		return LBytePredicateX.DESCRIPTION;
	}

	/** Captures arguments but delays the evaluation. */
	default LBoolSupplierX captureBytePred(byte b) {
		return () -> this.doTest(b);
	}

	/** Creates function that always returns the same value. */
	static  LBytePredicateX constant(boolean r) {
		return b -> r;
	}

	/** Convenient method in case lambda expression is ambiguous for the compiler (that might happen for overloaded methods accepting different interfaces). */
	@Nonnull
	static  LBytePredicateX lX(final @Nonnull LBytePredicateX lambda) {
		Null.nonNullArg(lambda, "lambda");
		return lambda;
	}

	/** Convenient method in case lambda expression is ambiguous for the compiler (that might happen for overloaded methods accepting different interfaces). */
	@Nonnull
	static  LBytePredicateX lX(@Nonnull Class xClass, final @Nonnull LBytePredicateX lambda) {
		Null.nonNullArg(lambda, "lambda");
		return lambda;
	}

	// 

	/** Wraps opposite (throwing vs non-throwing) instance. */
	@Nonnull
	static  LBytePredicateX wrapX(final @Nonnull LBytePredicate other) {
		return (LBytePredicateX) other;
	}

	// 
	// 

	/**
	 * Returns a predicate that represents the logical negation of this predicate.
	 *
	 * @see {@link java.util.function.Predicate#negate}
	 */
	@Nonnull
	default LBytePredicateX negate() {
		return b -> !doTest(b);
	}

	/**
	 * Returns a predicate that represents the logical AND of evaluation of this predicate and the argument one.
	 * @see {@link java.util.function.Predicate#and()}
	 */
	@Nonnull
	default LBytePredicateX and(@Nonnull LBytePredicateX other) {
		Null.nonNullArg(other, "other");
		return b -> doTest(b) && other.doTest(b);
	}

	/**
	 * Returns a predicate that represents the logical OR of evaluation of this predicate and the argument one.
	 * @see {@link java.util.function.Predicate#or}
	 */
	@Nonnull
	default LBytePredicateX or(@Nonnull LBytePredicateX other) {
		Null.nonNullArg(other, "other");
		return b -> doTest(b) || other.doTest(b);
	}

	/**
	 * Returns a predicate that represents the logical XOR of evaluation of this predicate and the argument one.
	 * @see {@link java.util.function.Predicate#or}
	 */
	@Nonnull
	default LBytePredicateX xor(@Nonnull LBytePredicateX other) {
		Null.nonNullArg(other, "other");
		return b -> doTest(b) ^ other.doTest(b);
	}

	/**
	 * Creates predicate that evaluates if an object is equal with the argument one.
	 * @see {@link java.util.function.Predicate#isEqual()
	 */
	@Nonnull
	static  LBytePredicateX isEqual(byte target) {
		return b -> b == target;
	}

	// 

	// 

	/** Allows to manipulate the domain of the function. */
	@Nonnull
	default LBytePredicateX bytePredComposeByte(@Nonnull final LByteUnaryOperatorX before1) {
		Null.nonNullArg(before1, "before1");
		return v1 -> this.doTest(before1.doApplyAsByte(v1));
	}

	/** Allows to manipulate the domain of the function. */
	@Nonnull
	default  LPredicateX bytePredCompose(@Nonnull final LToByteFunctionX before1) {
		Null.nonNullArg(before1, "before1");
		return v1 -> this.doTest(before1.doApplyAsByte(v1));
	}

	// 

	// 

	/** Combines two predicates together in a order. */
	@Nonnull
	default  LByteFunctionX boolToByteFunction(@Nonnull LBoolFunctionX after) {
		Null.nonNullArg(after, "after");
		return b -> after.doApply(this.doTest(b));
	}

	/** Combines two predicates together in a order. */
	@Nonnull
	default LByteUnaryOperatorX boolToByteUnaryOperator(@Nonnull LBoolToByteFunctionX after) {
		Null.nonNullArg(after, "after");
		return b -> after.doApplyAsByte(this.doTest(b));
	}

	/** Combines two predicates together in a order. */
	@Nonnull
	default LByteToShortFunctionX boolToByteToShortFunction(@Nonnull LBoolToShortFunctionX after) {
		Null.nonNullArg(after, "after");
		return b -> after.doApplyAsShort(this.doTest(b));
	}

	/** Combines two predicates together in a order. */
	@Nonnull
	default LByteToIntFunctionX boolToByteToIntFunction(@Nonnull LBoolToIntFunctionX after) {
		Null.nonNullArg(after, "after");
		return b -> after.doApplyAsInt(this.doTest(b));
	}

	/** Combines two predicates together in a order. */
	@Nonnull
	default LByteToLongFunctionX boolToByteToLongFunction(@Nonnull LBoolToLongFunctionX after) {
		Null.nonNullArg(after, "after");
		return b -> after.doApplyAsLong(this.doTest(b));
	}

	/** Combines two predicates together in a order. */
	@Nonnull
	default LByteToFloatFunctionX boolToByteToFloatFunction(@Nonnull LBoolToFloatFunctionX after) {
		Null.nonNullArg(after, "after");
		return b -> after.doApplyAsFloat(this.doTest(b));
	}

	/** Combines two predicates together in a order. */
	@Nonnull
	default LByteToDoubleFunctionX boolToByteToDoubleFunction(@Nonnull LBoolToDoubleFunctionX after) {
		Null.nonNullArg(after, "after");
		return b -> after.doApplyAsDouble(this.doTest(b));
	}

	/** Combines two predicates together in a order. */
	@Nonnull
	default LByteToCharFunctionX boolToByteToCharFunction(@Nonnull LBoolToCharFunctionX after) {
		Null.nonNullArg(after, "after");
		return b -> after.doApplyAsChar(this.doTest(b));
	}

	/** Combines two predicates together in a order. */
	@Nonnull
	default LBytePredicateX boolToBytePredicate(@Nonnull LLogicalOperatorX after) {
		Null.nonNullArg(after, "after");
		return b -> after.doApply(this.doTest(b));
	}

	// 
	// 

	/** Converts to non-throwing variant (if required). */
	@Nonnull
	default LBytePredicate nestingBytePred() {
		return this::nestingDoTest;
	}

	/** Converts to throwing variant (RuntimeException). */
	@Nonnull
	default LBytePredicateX nestingBytePredX() {
		return this::nestingDoTest;
	}

	/** Converts to non-throwing variant that will propagate checked exception as it would be unchecked - there is no exception wrapping involved (at least not here). */
	default LBytePredicate shovingBytePred() {
		return this::shovingDoTest;
	}

	/** Converts to throwing variant (RuntimeException) that will propagate checked exception as it would be unchecked - there is no exception wrapping involved (at least not here). */
	default LBytePredicateX shovingBytePredX() {
		return this::shovingDoTest;
	}

	// 

	// 

	/** Converts to function that handles exceptions according to the instructions. */
	@Nonnull
	default LBytePredicate handleBytePred(@Nonnull HandlingInstructions handling) {
		return b -> this.handlingDoTest(b, handling);
	}

	/** Converts to function that handles exceptions according to the instructions. */
	@Nonnull
	default  LBytePredicateX handleBytePredX(@Nonnull HandlingInstructions handling) {
		return b -> this.handlingDoTest(b, handling);
	}

	// 

}