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

eu.lunisolar.magma.func.supplier.LBoolSupplierX 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.supplier;

import javax.annotation.Nonnull; // NOSONAR
import javax.annotation.Nullable; // 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) LBoolSupplierX for Java 8.
 *
 * Type: supplier
 *
 * Domain (lvl: 0): none
 *
 * Co-domain: none
 *
 * @see LBoolSupplier
 */
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LBoolSupplierX extends java.util.function.BooleanSupplier, MetaSupplier, PrimitiveCodomain, MetaInterface.Throwing {

	static final String DESCRIPTION = "LBoolSupplierX: boolean doGetAsBool() throws X";

	/**
	 * Default implementation for JRE method that calls exception nesting method.
	 * @deprecated Calling this method via LBoolSupplierX interface should be discouraged.
	 */
	@Override
	@Deprecated
	default boolean getAsBoolean() {
		return this.nestingDoGetAsBool();
	}

	boolean doGetAsBool() throws X;

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

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

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

	/** Just to mirror the method: Ensures the result is not null */
	default boolean nonNullDoGetAsBool() throws X {
		return doGetAsBool();
	}

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

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

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

	// 

	/** Wraps JRE instance. */
	@Nonnull
	static  LBoolSupplierX wrap(final java.util.function.BooleanSupplier other) {
		return other::getAsBoolean;
	}

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

	// 

	// 

	/** Combines two suppliers together in a order. */
	@Nonnull
	default  LSupplierX toSupplier(@Nonnull LBoolFunctionX after) {
		Null.nonNullArg(after, "after");
		return () -> after.doApply(this.doGetAsBool());
	}

	/** Combines two suppliers together in a order. */
	@Nonnull
	default LByteSupplierX toByteSupplier(@Nonnull LBoolToByteFunctionX after) {
		Null.nonNullArg(after, "after");
		return () -> after.doApplyAsByte(this.doGetAsBool());
	}

	/** Combines two suppliers together in a order. */
	@Nonnull
	default LShortSupplierX toShortSupplier(@Nonnull LBoolToShortFunctionX after) {
		Null.nonNullArg(after, "after");
		return () -> after.doApplyAsShort(this.doGetAsBool());
	}

	/** Combines two suppliers together in a order. */
	@Nonnull
	default LIntSupplierX toIntSupplier(@Nonnull LBoolToIntFunctionX after) {
		Null.nonNullArg(after, "after");
		return () -> after.doApplyAsInt(this.doGetAsBool());
	}

	/** Combines two suppliers together in a order. */
	@Nonnull
	default LLongSupplierX toLongSupplier(@Nonnull LBoolToLongFunctionX after) {
		Null.nonNullArg(after, "after");
		return () -> after.doApplyAsLong(this.doGetAsBool());
	}

	/** Combines two suppliers together in a order. */
	@Nonnull
	default LFloatSupplierX toFloatSupplier(@Nonnull LBoolToFloatFunctionX after) {
		Null.nonNullArg(after, "after");
		return () -> after.doApplyAsFloat(this.doGetAsBool());
	}

	/** Combines two suppliers together in a order. */
	@Nonnull
	default LDoubleSupplierX toDoubleSupplier(@Nonnull LBoolToDoubleFunctionX after) {
		Null.nonNullArg(after, "after");
		return () -> after.doApplyAsDouble(this.doGetAsBool());
	}

	/** Combines two suppliers together in a order. */
	@Nonnull
	default LCharSupplierX toCharSupplier(@Nonnull LBoolToCharFunctionX after) {
		Null.nonNullArg(after, "after");
		return () -> after.doApplyAsChar(this.doGetAsBool());
	}

	/** Combines two suppliers together in a order. */
	@Nonnull
	default LBoolSupplierX toBoolSupplier(@Nonnull LLogicalOperatorX after) {
		Null.nonNullArg(after, "after");
		return () -> after.doApply(this.doGetAsBool());
	}

	// 
	// 

	/** Converts to non-throwing variant (if required). */
	@Nonnull
	default LBoolSupplier nestingBoolSup() {
		return this::nestingDoGetAsBool;
	}

	/** Converts to throwing variant (RuntimeException). */
	@Nonnull
	default LBoolSupplierX nestingBoolSupX() {
		return this::nestingDoGetAsBool;
	}

	/** 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 LBoolSupplier shovingBoolSup() {
		return this::shovingDoGetAsBool;
	}

	/** 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 LBoolSupplierX shovingBoolSupX() {
		return this::shovingDoGetAsBool;
	}

	// 

	// 

	/** Converts to function that handles exceptions according to the instructions. */
	@Nonnull
	default LBoolSupplier handleBoolSup(@Nonnull HandlingInstructions handling) {
		return () -> this.handlingDoGetAsBool(handling);
	}

	/** Converts to function that handles exceptions according to the instructions. */
	@Nonnull
	default  LBoolSupplierX handleBoolSupX(@Nonnull HandlingInstructions handling) {
		return () -> this.handlingDoGetAsBool(handling);
	}

	// 

}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy