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

eu.lunisolar.magma.func.operator.unary.LIntUnaryOperatorX 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.operator.unary;
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) LIntUnaryOperatorX for Java 8.
 *
 * Type: operator
 *
 * Domain (lvl: 1): int i
 *
 * Co-domain: none
 *
 * @see LIntUnaryOperator
 */
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LIntUnaryOperatorX extends java.util.function.IntUnaryOperator, MetaOperator, PrimitiveCodomain, MetaInterface.Throwing { // NOSONAR

	static final String DESCRIPTION = "LIntUnaryOperatorX: int doApplyAsInt(int i) throws X";

	/**
	 * Default implementation for JRE method that calls exception nesting method.
	 * @deprecated Calling this method via LIntUnaryOperatorX interface should be discouraged.
	 */
	@Override
	@Deprecated
	default int applyAsInt(int i) {
		return this.nestingDoApplyAsInt(i);
	}

	int doApplyAsInt(int i) throws X;

	/** Function call that handles exceptions by always nesting checked exceptions and propagating the otheres as is. */
	default int nestingDoApplyAsInt(int i) {
		try {
			return this.doApplyAsInt(i);
		} 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 int shovingDoApplyAsInt(int i) {
		return ((LIntUnaryOperatorX) this).doApplyAsInt(i);
	}

	/** Function call that handles exceptions according to the instructions. */
	default  int handlingDoApplyAsInt(int i, HandlingInstructions handling) throws Y {

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

	/** Just to mirror the method: Ensures the result is not null */
	default int nonNullDoApplyAsInt(int i) throws X {
		return doApplyAsInt(i);
	}

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

	/** Captures arguments but delays the evaluation. */
	default LIntSupplierX captureIntUnaryOp(int i) {
		return () -> this.doApplyAsInt(i);
	}

	/** Creates function that always returns the same value. */
	static  LIntUnaryOperatorX constant(int r) {
		return i -> r;
	}

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

	// 

	/** Wraps JRE instance. */
	@Nonnull
	static  LIntUnaryOperatorX wrap(final java.util.function.IntUnaryOperator other) {
		return other::applyAsInt;
	}

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

	// 

	// 

	/** Allows to manipulate the domain of the function. */
	@Nonnull
	default LIntUnaryOperatorX intUnaryOpComposeInt(@Nonnull final LIntUnaryOperatorX before1) {
		Null.nonNullArg(before1, "before1");
		return v1 -> this.doApplyAsInt(before1.doApplyAsInt(v1));
	}

	/** Allows to manipulate the domain of the function. */
	@Nonnull
	default  LToIntFunctionX intUnaryOpCompose(@Nonnull final LToIntFunctionX before1) {
		Null.nonNullArg(before1, "before1");
		return v1 -> this.doApplyAsInt(before1.doApplyAsInt(v1));
	}

	// 

	// 

	/** Combines two operators together in a order. */
	@Nonnull
	default  LIntFunctionX then(@Nonnull LIntFunctionX after) {
		Null.nonNullArg(after, "after");
		return i -> after.doApply(this.doApplyAsInt(i));
	}

	/** Combines two operators together in a order. */
	@Nonnull
	default LIntToByteFunctionX thenToByte(@Nonnull LIntToByteFunctionX after) {
		Null.nonNullArg(after, "after");
		return i -> after.doApplyAsByte(this.doApplyAsInt(i));
	}

	/** Combines two operators together in a order. */
	@Nonnull
	default LIntToShortFunctionX thenToShort(@Nonnull LIntToShortFunctionX after) {
		Null.nonNullArg(after, "after");
		return i -> after.doApplyAsShort(this.doApplyAsInt(i));
	}

	/** Combines two operators together in a order. */
	@Nonnull
	default LIntUnaryOperatorX thenToInt(@Nonnull LIntUnaryOperatorX after) {
		Null.nonNullArg(after, "after");
		return i -> after.doApplyAsInt(this.doApplyAsInt(i));
	}

	/** Combines two operators together in a order. */
	@Nonnull
	default LIntToLongFunctionX thenToLong(@Nonnull LIntToLongFunctionX after) {
		Null.nonNullArg(after, "after");
		return i -> after.doApplyAsLong(this.doApplyAsInt(i));
	}

	/** Combines two operators together in a order. */
	@Nonnull
	default LIntToFloatFunctionX thenToFloat(@Nonnull LIntToFloatFunctionX after) {
		Null.nonNullArg(after, "after");
		return i -> after.doApplyAsFloat(this.doApplyAsInt(i));
	}

	/** Combines two operators together in a order. */
	@Nonnull
	default LIntToDoubleFunctionX thenToDouble(@Nonnull LIntToDoubleFunctionX after) {
		Null.nonNullArg(after, "after");
		return i -> after.doApplyAsDouble(this.doApplyAsInt(i));
	}

	/** Combines two operators together in a order. */
	@Nonnull
	default LIntToCharFunctionX thenToChar(@Nonnull LIntToCharFunctionX after) {
		Null.nonNullArg(after, "after");
		return i -> after.doApplyAsChar(this.doApplyAsInt(i));
	}

	/** Combines two operators together in a order. */
	@Nonnull
	default LIntPredicateX thenToBoolean(@Nonnull LIntPredicateX after) {
		Null.nonNullArg(after, "after");
		return i -> after.doTest(this.doApplyAsInt(i));
	}

	// 

	/** Returns a function that always returns its input argument. */
	@Nonnull
	static  LIntUnaryOperatorX identity() {
		return t -> t;
	}
	// 

	/** Converts to non-throwing variant (if required). */
	@Nonnull
	default LIntUnaryOperator nestingIntUnaryOp() {
		return this::nestingDoApplyAsInt;
	}

	/** Converts to throwing variant (RuntimeException). */
	@Nonnull
	default LIntUnaryOperatorX nestingIntUnaryOpX() {
		return this::nestingDoApplyAsInt;
	}

	/** 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 LIntUnaryOperator shovingIntUnaryOp() {
		return this::shovingDoApplyAsInt;
	}

	/** 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 LIntUnaryOperatorX shovingIntUnaryOpX() {
		return this::shovingDoApplyAsInt;
	}

	// 

	// 

	/** Converts to function that handles exceptions according to the instructions. */
	@Nonnull
	default LIntUnaryOperator handleIntUnaryOp(@Nonnull HandlingInstructions handling) {
		return i -> this.handlingDoApplyAsInt(i, handling);
	}

	/** Converts to function that handles exceptions according to the instructions. */
	@Nonnull
	default  LIntUnaryOperatorX handleIntUnaryOpX(@Nonnull HandlingInstructions handling) {
		return i -> this.handlingDoApplyAsInt(i, handling);
	}

	// 

}