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

eu.lunisolar.magma.func.function.from.LLongFunction 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.function.from;

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.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.*; // NOSONAR
import java.lang.reflect.*;

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) LLongFunction for Java 8.
 *
 * Type: function
 *
 * Domain (lvl: 1): long a
 *
 * Co-domain: R
 *
 */
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LLongFunction extends LongFunction, MetaFunction, MetaInterface.NonThrowing, Codomain>, Domain1 { // NOSONAR

	String DESCRIPTION = "LLongFunction: R apply(long a)";

	@Nullable
	// R apply(long a) ;
	default R apply(long a) {
		// return nestingApply(a);
		try {
			return this.applyX(a);
		} catch (Throwable e) { // NOSONAR
			throw Handling.nestCheckedAndThrow(e);
		}
	}

	/**
	 * Implement this, but call apply(long a)
	 */
	R applyX(long a) throws Throwable;

	default R tupleApply(LLongSingle args) {
		return apply(args.value());
	}

	/** Function call that handles exceptions according to the instructions. */
	default R handlingApply(long a, HandlingInstructions handling) {
		try {
			return this.applyX(a);
		} catch (Throwable e) { // NOSONAR
			throw Handler.handleOrNest(e, handling);
		}
	}

	default LLongFunction handling(HandlingInstructions handling) {
		return a -> handlingApply(a, handling);
	}

	default R apply(long a, @Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
		try {
			return this.applyX(a);
		} catch (Throwable e) { // NOSONAR
			throw Handling.wrap(e, exF, newMessage, messageParams);
		}
	}

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

	default R apply(long a, @Nonnull ExWF exF) {
		try {
			return this.applyX(a);
		} catch (Throwable e) { // NOSONAR
			throw Handling.wrap(e, exF);
		}
	}

	default LLongFunction trying(@Nonnull ExWF exF) {
		return a -> apply(a, exF);
	}

	default R applyThen(long a, @Nonnull LFunction handler) {
		try {
			return this.applyX(a);
		} catch (Throwable e) { // NOSONAR
			Handling.handleErrors(e);
			return handler.apply(e);
		}
	}

	default LLongFunction tryingThen(@Nonnull LFunction handler) {
		return a -> applyThen(a, handler);
	}

	/** Function call that handles exceptions by always nesting checked exceptions and propagating the others as is. */
	default R nestingApply(long a) {
		try {
			return this.applyX(a);
		} 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 R shovingApply(long a) {
		try {
			return this.applyX(a);
		} catch (Throwable e) { // NOSONAR
			throw Handling.shoveIt(e);
		}
	}

	static  R handlingApply(long a, LLongFunction func, HandlingInstructions handling) { // <-
		Null.nonNullArg(func, "func");
		return func.handlingApply(a, handling);
	}

	static  R tryApply(long a, LLongFunction func) {
		Null.nonNullArg(func, "func");
		return func.nestingApply(a);
	}

	static  R tryApply(long a, LLongFunction func, @Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
		Null.nonNullArg(func, "func");
		return func.apply(a, exF, newMessage, messageParams);
	}

	static  R tryApply(long a, LLongFunction func, @Nonnull ExWF exF) {
		Null.nonNullArg(func, "func");
		return func.apply(a, exF);
	}

	static  R tryApplyThen(long a, LLongFunction func, @Nonnull LFunction handler) {
		Null.nonNullArg(func, "func");
		return func.applyThen(a, handler);
	}

	default R failSafeApply(long a, @Nonnull LLongFunction failSafe) {
		try {
			return apply(a);
		} catch (Throwable e) { // NOSONAR
			Handling.handleErrors(e);
			return failSafe.apply(a);
		}
	}

	static  R failSafeApply(long a, LLongFunction func, @Nonnull LLongFunction failSafe) {
		Null.nonNullArg(failSafe, "failSafe");
		if (func == null) {
			return failSafe.apply(a);
		} else {
			return func.failSafeApply(a, failSafe);
		}
	}

	static  LLongFunction failSafe(LLongFunction func, @Nonnull LLongFunction failSafe) {
		Null.nonNullArg(failSafe, "failSafe");
		return a -> failSafeApply(a, func, failSafe);
	}

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

	/** Function call that ensures the result is not null */
	@Nonnull
	default R nonNullApply(long a) {
		return Null.requireNonNull(apply(a), NULL_VALUE_MESSAGE_SUPPLIER);
	}

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

	/** From-To. Intended to be used with non-capturing lambda. */
	public static  void fromTo(long min_a, long max_a, LLongFunction func) {
		Null.nonNullArg(func, "func");
		if (min_a <= max_a) {
			for (long a = min_a; a <= max_a; a++) {
				func.apply(a);
			}
		} else {
			for (long a = min_a; a >= max_a; a--) {
				func.apply(a);
			}
		}
	}

	/** From-To. Intended to be used with non-capturing lambda. */
	public static  void fromTill(long min_a, long max_a, LLongFunction func) {
		Null.nonNullArg(func, "func");
		if (min_a <= max_a) {
			for (long a = min_a; a < max_a; a++) {
				func.apply(a);
			}
		} else {
			for (long a = min_a; a > max_a; a--) {
				func.apply(a);
			}
		}
	}

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

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

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

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

	/** Captures arguments but delays the evaluation. */
	default LSupplier capture(long a) {
		return () -> this.apply(a);
	}

	/** Creates function that always returns the same value. */
	static  LLongFunction constant(R r) {
		return a -> r;
	}

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

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

	final class LLongFunctionSingle implements LSingle>, LLongFunction {
		private LLongFunction target = null;

		@Override
		public R applyX(long a) throws Throwable {
			return target.applyX(a);
		}

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

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

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

	static  R call(long a, final @Nonnull LLongFunction lambda) {
		Null.nonNullArg(lambda, "lambda");
		return lambda.apply(a);
	}

	// 

	/** Wraps JRE instance. */
	@Nonnull
	static  LLongFunction wrap(final LongFunction other) {
		return other::apply;
	}
	// 

	// 

	/** Safe instance. That always returns the same value (as produce). */
	@Nonnull
	static  LLongFunction safe() {
		return LLongFunction::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  LLongFunction safe(final @Nullable LLongFunction 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;
		}
	}

	// 

	// 

	/** Allows to manipulate the domain of the function. */
	@Nonnull
	default LLongFunction compose(@Nonnull final LLongUnaryOperator before) {
		Null.nonNullArg(before, "before");
		return v -> this.apply(before.applyAsLong(v));
	}

	public static  LLongFunction composed(@Nonnull final LLongUnaryOperator before, LLongFunction after) {
		return after.compose(before);
	}

	/** Allows to manipulate the domain of the function. */
	@Nonnull
	default  LFunction longFuncCompose(@Nonnull final LToLongFunction before) {
		Null.nonNullArg(before, "before");
		return v -> this.apply(before.applyAsLong(v));
	}

	public static  LFunction composed(@Nonnull final LToLongFunction before, LLongFunction after) {
		return after.longFuncCompose(before);
	}

	// 

	// 

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

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

	@Nonnull
	default LLongFunction before(@Nonnull LLongConsumer before) {
		Null.nonNullArg(before, "before");
		return a -> {
			before.accept(a);
			return this.apply(a);
		};
	}

	@Nonnull
	default LLongFunction after(@Nonnull LConsumer after) {
		Null.nonNullArg(after, "after");
		return a -> {
			R result = this.apply(a);
			after.accept(result);
			return result;
		};
	}

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

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

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

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

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

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

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

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

	// 

	// 

	// 

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

	/** Does nothing (LLongFunction) Function */
	public static  R produce(long a) {
		return (R) Function4U.defaultObject;
	}

	/**
	* For each element (or tuple) from arguments, calls the function and passes the result to consumer.
	* Thread safety, fail-fast, fail-safety of this method is not expected.
	*/
	default  void forEach(IndexedRead ia, C0 source, LConsumer consumer) {
		int size = ia.size(source);
		LOiToLongFunction oiFunc0 = (LOiToLongFunction) ia.getter();
		int i = 0;
		for (; i < size; i++) {
			long a = oiFunc0.applyAsLong(source, i);
			consumer.accept(this.apply(a));
		}
	}

	/**
	* For each element (or tuple) from arguments, calls the function and passes the result to consumer.
	* Thread safety, fail-fast, fail-safety of this method depends highly on the arguments.
	*/
	default  void iterate(SequentialRead sa, C0 source, LConsumer consumer) {
		Object iterator0 = ((LFunction) sa.adapter()).apply(source);
		LPredicate testFunc0 = (LPredicate) sa.tester();
		LToLongFunction nextFunc0 = (LToLongFunction) sa.supplier();
		while (testFunc0.test(iterator0)) {
			long a = nextFunc0.applyAsLong(iterator0);
			consumer.accept(this.apply(a));
		}
	}

}