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

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

Go to download

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) LShortPredicateX for Java 8.
 *
 * Type: predicate
 *
 * Domain (lvl: 1): short s
 *
 * Co-domain: none
 *
 * @see LShortPredicate
 */
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LShortPredicateX extends MetaPredicate, PrimitiveCodomain, MetaInterface.Throwing { // NOSONAR

	static final String DESCRIPTION = "LShortPredicateX: boolean doTest(short s) throws X";

	boolean doTest(short s) throws X;

	/** Function call that handles exceptions by always nesting checked exceptions and propagating the otheres as is. */
	default boolean nestingDoTest(short s) {
		try {
			return this.doTest(s);
		} 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(short s) {
		return ((LShortPredicateX) this).doTest(s);
	}

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

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

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

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

	default boolean doApplyAsBoolean(short s) throws X {
		return doTest(s);
	}

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

	/** Captures arguments but delays the evaluation. */
	default LBoolSupplierX captureShortPred(short s) {
		return () -> this.doTest(s);
	}

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

	/** Convenient method in case lambda expression is ambiguous for the compiler (that might happen for overloaded methods accepting different interfaces). */
	@Nonnull
	static  LShortPredicateX lX(final @Nonnull LShortPredicateX 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  LShortPredicateX lX(@Nonnull Class xClass, final @Nonnull LShortPredicateX lambda) {
		Null.nonNullArg(lambda, "lambda");
		return lambda;
	}

	// 

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

	// 
	// 

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

	/**
	 * 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 LShortPredicateX and(@Nonnull LShortPredicateX other) {
		Null.nonNullArg(other, "other");
		return s -> doTest(s) && other.doTest(s);
	}

	/**
	 * 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 LShortPredicateX or(@Nonnull LShortPredicateX other) {
		Null.nonNullArg(other, "other");
		return s -> doTest(s) || other.doTest(s);
	}

	/**
	 * 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 LShortPredicateX xor(@Nonnull LShortPredicateX other) {
		Null.nonNullArg(other, "other");
		return s -> doTest(s) ^ other.doTest(s);
	}

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

	// 

	// 

	/** Allows to manipulate the domain of the function. */
	@Nonnull
	default LShortPredicateX shortPredComposeShort(@Nonnull final LShortUnaryOperatorX before1) {
		Null.nonNullArg(before1, "before1");
		return v1 -> this.doTest(before1.doApplyAsShort(v1));
	}

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

	// 

	// 

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

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

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

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

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

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

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

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

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

	// 
	// 

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

	/** Converts to throwing variant (RuntimeException). */
	@Nonnull
	default LShortPredicateX nestingShortPredX() {
		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 LShortPredicate shovingShortPred() {
		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 LShortPredicateX shovingShortPredX() {
		return this::shovingDoTest;
	}

	// 

	// 

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

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

	// 

}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy