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

eu.lunisolar.magma.func.supplier.LSupplier Maven / Gradle / Ivy

There is a newer version: 3.0.0
Show newest version
/*
 * This file is part of "lunisolar-magma".
 *
 * (C) Copyright 2014-2019 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.aType.*; // 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.IA;
import eu.lunisolar.magma.func.SA;
import eu.lunisolar.magma.func.*; // NOSONAR
import eu.lunisolar.magma.func.tuple.*; // NOSONAR
import java.util.function.*; // NOSONAR
import java.util.*;

import eu.lunisolar.magma.func.action.*; // 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.obj.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.tri.*; // NOSONAR
import eu.lunisolar.magma.func.function.*; // NOSONAR
import eu.lunisolar.magma.func.function.conversion.*; // NOSONAR
import eu.lunisolar.magma.func.function.from.*; // NOSONAR
import eu.lunisolar.magma.func.function.to.*; // NOSONAR
import eu.lunisolar.magma.func.operator.binary.*; // NOSONAR
import eu.lunisolar.magma.func.operator.ternary.*; // NOSONAR
import eu.lunisolar.magma.func.operator.unary.*; // NOSONAR
import eu.lunisolar.magma.func.predicate.*; // NOSONAR
import eu.lunisolar.magma.func.supplier.*; // NOSONAR

/**
 * Non-throwing functional interface (lambda) LSupplier for Java 8.
 *
 * Type: supplier
 *
 * Domain (lvl: 0): none
 *
 * Co-domain: T
 *
 */
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LSupplier extends Supplier, MetaSupplier, MetaInterface.NonThrowing, Codomain>, Domain0 { // NOSONAR

	String DESCRIPTION = "LSupplier: T get()";

	@Nullable
	// T get() ;
	default T get() {
		// return nestingGet();
		try {
			return this.getX();
		} catch (Throwable e) { // NOSONAR
			throw Handling.nestCheckedAndThrow(e);
		}
	}

	/**
	 * Implement this, but call get()
	 */
	T getX() throws Throwable;

	default T tupleGet(LTuple.Void args) {
		return get();
	}

	/** Function call that handles exceptions according to the instructions. */
	default T handlingGet(HandlingInstructions handling) {
		try {
			return this.getX();
		} catch (Throwable e) { // NOSONAR
			throw Handler.handleOrNest(e, handling);
		}
	}

	default LSupplier handling(HandlingInstructions handling) {
		return () -> handlingGet(handling);
	}

	default T get(@Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
		try {
			return this.getX();
		} catch (Throwable e) { // NOSONAR
			throw Handling.wrap(e, exF, newMessage, messageParams);
		}
	}

	default LSupplier trying(@Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
		return () -> get(exF, newMessage, messageParams);
	}

	default T get(@Nonnull ExWF exF) {
		try {
			return this.getX();
		} catch (Throwable e) { // NOSONAR
			throw Handling.wrap(e, exF);
		}
	}

	default LSupplier trying(@Nonnull ExWF exF) {
		return () -> get(exF);
	}

	default T getThen(@Nonnull LFunction handler) {
		try {
			return this.getX();
		} catch (Throwable e) { // NOSONAR
			Handling.handleErrors(e);
			return handler.apply(e);
		}
	}

	default LSupplier tryingThen(@Nonnull LFunction handler) {
		return () -> getThen(handler);
	}

	/** Function call that handles exceptions by always nesting checked exceptions and propagating the others as is. */
	default T nestingGet() {
		try {
			return this.getX();
		} catch (Throwable e) { // NOSONAR
			throw Handling.nestCheckedAndThrow(e);
		}
	}

	/** Function call that handles exceptions by always propagating them as is, even when they are undeclared checked ones. */
	default T shovingGet() {
		try {
			return this.getX();
		} catch (Throwable e) { // NOSONAR
			throw Handling.shoveIt(e);
		}
	}

	static  T handlingGet(LSupplier func, HandlingInstructions handling) { // <-
		Null.nonNullArg(func, "func");
		return func.handlingGet(handling);
	}

	static  T tryGet(LSupplier func) {
		Null.nonNullArg(func, "func");
		return func.nestingGet();
	}

	static  T tryGet(LSupplier func, @Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
		Null.nonNullArg(func, "func");
		return func.get(exF, newMessage, messageParams);
	}

	static  T tryGet(LSupplier func, @Nonnull ExWF exF) {
		Null.nonNullArg(func, "func");
		return func.get(exF);
	}

	static  T tryGetThen(LSupplier func, @Nonnull LFunction handler) {
		Null.nonNullArg(func, "func");
		return func.getThen(handler);
	}

	default T failSafeGet(@Nonnull LSupplier failSafe) {
		try {
			return get();
		} catch (Throwable e) { // NOSONAR
			Handling.handleErrors(e);
			return failSafe.get();
		}
	}

	static  T failSafeGet(LSupplier func, @Nonnull LSupplier failSafe) {
		Null.nonNullArg(failSafe, "failSafe");
		if (func == null) {
			return failSafe.get();
		} else {
			return func.failSafeGet(failSafe);
		}
	}

	static  LSupplier failSafe(LSupplier func, @Nonnull LSupplier failSafe) {
		Null.nonNullArg(failSafe, "failSafe");
		return () -> failSafeGet(func, failSafe);
	}

	LSupplier NULL_VALUE_MESSAGE_SUPPLIER = () -> "Evaluated value by nonNullGet() method cannot be null (" + DESCRIPTION + ").";

	/** Function call that ensures the result is not null */
	@Nonnull
	default T nonNullGet() {
		return Null.requireNonNull(get(), NULL_VALUE_MESSAGE_SUPPLIER);
	}

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

	/** From-To. Intended to be used with non-capturing lambda. */
	public static  void fromTo(int min_i, int max_i, LSupplier func) {
		Null.nonNullArg(func, "func");
		if (min_i <= max_i) {
			for (int i = min_i; i <= max_i; i++) {
				func.get();
			}
		} else {
			for (int i = min_i; i >= max_i; i--) {
				func.get();
			}
		}
	}

	/** From-To. Intended to be used with non-capturing lambda. */
	public static  void fromTill(int min_i, int max_i, LSupplier func) {
		Null.nonNullArg(func, "func");
		if (min_i <= max_i) {
			for (int i = min_i; i < max_i; i++) {
				func.get();
			}
		} else {
			for (int i = min_i; i > max_i; i--) {
				func.get();
			}
		}
	}

	/** From-To. Intended to be used with non-capturing lambda. */
	public static  void times(int max_i, LSupplier func) {
		if (max_i < 0)
			return;
		fromTill(0, max_i, func);
	}

	/** Cast that removes generics. */
	public default LSupplier untyped() {
		return this;
	}

	/** Cast that replace generics. */
	public default  LSupplier cast() {
		return untyped();
	}

	/** Cast that replace generics. */
	public static  LSupplier cast(LSupplier function) {
		return (LSupplier) function;
	}

	/** Creates function that always returns the same value. */
	static  LSupplier of(T 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  LSupplier sup(final @Nonnull LSupplier lambda) {
		Null.nonNullArg(lambda, "lambda");
		return lambda;
	}

	@Nonnull
	static  LSupplier recursive(final @Nonnull LFunction, LSupplier> selfLambda) {
		final LSupplierSingle single = new LSupplierSingle();
		LSupplier func = selfLambda.apply(single);
		single.target = func;
		return func;
	}

	final class LSupplierSingle implements LSingle>, LSupplier {
		private LSupplier target = null;

		@Override
		public T getX() throws Throwable {
			return target.getX();
		}

		@Override
		public LSupplier value() {
			return target;
		}
	}

	@Nonnull
	static  LSupplier supThrowing(final @Nonnull ExF exF) {
		Null.nonNullArg(exF, "exF");
		return () -> {
			throw exF.produce();
		};
	}

	@Nonnull
	static  LSupplier supThrowing(final String message, final @Nonnull ExMF exF) {
		Null.nonNullArg(exF, "exF");
		return () -> {
			throw exF.produce(message);
		};
	}

	static  T call(final @Nonnull LSupplier lambda) {
		Null.nonNullArg(lambda, "lambda");
		return lambda.get();
	}

	// 

	/** Wraps JRE instance. */
	@Nonnull
	static  LSupplier wrap(final Supplier other) {
		return other::get;
	}
	// 

	// 

	/** Safe instance. That always returns the same value (as produce). */
	@Nonnull
	static  LSupplier safe() {
		return LSupplier::produce;
	}

	/** Safe instance supplier. Returns supplier of safe() instance. */
	@Nonnull
	static  LSupplier> safeSupplier() {
		return () -> safe();
	}

	/** Safe wrapping. Either argument function is returned (if it is not null) or safe() instance. */
	@Nonnull
	static  LSupplier safe(final @Nullable LSupplier other) {
		if (other == null) {
			return safe();
		} else {
			return other;
		}
	}

	/** Safe supplier. Either argument supplier is returned (if it is not null) or supplier of safe() instance. */
	@Nonnull
	static  LSupplier> safeSupplier(final @Nullable LSupplier> supplier) {
		if (supplier == null) {
			return safeSupplier();
		} else {
			return supplier;
		}
	}

	// 

	// 

	/** Combines two functions together in a order. */
	@Nonnull
	default  LSupplier toSup(@Nonnull LFunction after) {
		Null.nonNullArg(after, "after");
		return () -> after.apply(this.get());
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LAction toAct(@Nonnull LConsumer after) {
		Null.nonNullArg(after, "after");
		return () -> after.accept(this.get());
	}

	@Nonnull
	default LSupplier before(@Nonnull LAction before) {
		Null.nonNullArg(before, "before");
		return () -> {
			before.execute();
			return this.get();
		};
	}

	@Nonnull
	default LSupplier after(@Nonnull LConsumer after) {
		Null.nonNullArg(after, "after");
		return () -> {
			T result = this.get();
			after.accept(result);
			return result;
		};
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LByteSupplier toByteSup(@Nonnull LToByteFunction after) {
		Null.nonNullArg(after, "after");
		return () -> after.applyAsByte(this.get());
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LSrtSupplier toSrtSup(@Nonnull LToSrtFunction after) {
		Null.nonNullArg(after, "after");
		return () -> after.applyAsSrt(this.get());
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LIntSupplier toIntSup(@Nonnull LToIntFunction after) {
		Null.nonNullArg(after, "after");
		return () -> after.applyAsInt(this.get());
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LLongSupplier toLongSup(@Nonnull LToLongFunction after) {
		Null.nonNullArg(after, "after");
		return () -> after.applyAsLong(this.get());
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LFltSupplier toFltSup(@Nonnull LToFltFunction after) {
		Null.nonNullArg(after, "after");
		return () -> after.applyAsFlt(this.get());
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LDblSupplier toDblSup(@Nonnull LToDblFunction after) {
		Null.nonNullArg(after, "after");
		return () -> after.applyAsDbl(this.get());
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LCharSupplier toCharSup(@Nonnull LToCharFunction after) {
		Null.nonNullArg(after, "after");
		return () -> after.applyAsChar(this.get());
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LBoolSupplier toBoolSup(@Nonnull LPredicate after) {
		Null.nonNullArg(after, "after");
		return () -> after.test(this.get());
	}

	// 

	// 

	// 

	/** Converts to function that makes sure that the result is not null. */
	@Nonnull
	default LSupplier nonNullable() {
		return this::nonNullGet;
	}

	/** Does nothing (LSupplier) Supplier */
	public static  T produce() {
		return (T) Function4U.defaultObject;
	}

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy