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

eu.lunisolar.magma.func.function.to.LToCharFunctionX 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.function.to;
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) LToCharFunctionX for Java 8.
 *
 * Type: function
 *
 * Domain (lvl: 1): T t
 *
 * Co-domain: none
 *
 * @see LToCharFunction
 */
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LToCharFunctionX extends MetaFunction, PrimitiveCodomain, MetaInterface.Throwing { // NOSONAR

	static final String DESCRIPTION = "LToCharFunctionX: char doApplyAsChar(T t) throws X";

	char doApplyAsChar(T t) throws X;

	/** Function call that handles exceptions by always nesting checked exceptions and propagating the otheres as is. */
	default char nestingDoApplyAsChar(T t) {
		try {
			return this.doApplyAsChar(t);
		} 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 char shovingDoApplyAsChar(T t) {
		return ((LToCharFunctionX) this).doApplyAsChar(t);
	}

	/** Function call that handles exceptions according to the instructions. */
	default  char handlingDoApplyAsChar(T t, HandlingInstructions handling) throws Y {

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

	/** Just to mirror the method: Ensures the result is not null */
	default char nonNullDoApplyAsChar(T t) throws X {
		return doApplyAsChar(t);
	}

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

	/** Captures arguments but delays the evaluation. */
	default LCharSupplierX captureToCharFunc(T t) {
		return () -> this.doApplyAsChar(t);
	}

	/** Creates function that always returns the same value. */
	static  LToCharFunctionX constant(char r) {
		return t -> r;
	}

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

	// 

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

	// 

	// 

	/** Allows to manipulate the domain of the function. */
	@Nonnull
	default  LToCharFunctionX toCharFuncCompose(@Nonnull final LFunctionX before1) {
		Null.nonNullArg(before1, "before1");
		return v1 -> this.doApplyAsChar(before1.doApply(v1));
	}

	// 

	// 

	/** Combines two functions together in a order. */
	@Nonnull
	default  LFunctionX then(@Nonnull LCharFunctionX after) {
		Null.nonNullArg(after, "after");
		return t -> after.doApply(this.doApplyAsChar(t));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LToByteFunctionX thenToByte(@Nonnull LCharToByteFunctionX after) {
		Null.nonNullArg(after, "after");
		return t -> after.doApplyAsByte(this.doApplyAsChar(t));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LToShortFunctionX thenToShort(@Nonnull LCharToShortFunctionX after) {
		Null.nonNullArg(after, "after");
		return t -> after.doApplyAsShort(this.doApplyAsChar(t));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LToIntFunctionX thenToInt(@Nonnull LCharToIntFunctionX after) {
		Null.nonNullArg(after, "after");
		return t -> after.doApplyAsInt(this.doApplyAsChar(t));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LToLongFunctionX thenToLong(@Nonnull LCharToLongFunctionX after) {
		Null.nonNullArg(after, "after");
		return t -> after.doApplyAsLong(this.doApplyAsChar(t));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LToFloatFunctionX thenToFloat(@Nonnull LCharToFloatFunctionX after) {
		Null.nonNullArg(after, "after");
		return t -> after.doApplyAsFloat(this.doApplyAsChar(t));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LToDoubleFunctionX thenToDouble(@Nonnull LCharToDoubleFunctionX after) {
		Null.nonNullArg(after, "after");
		return t -> after.doApplyAsDouble(this.doApplyAsChar(t));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LToCharFunctionX thenToChar(@Nonnull LCharUnaryOperatorX after) {
		Null.nonNullArg(after, "after");
		return t -> after.doApplyAsChar(this.doApplyAsChar(t));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LPredicateX thenToBoolean(@Nonnull LCharPredicateX after) {
		Null.nonNullArg(after, "after");
		return t -> after.doTest(this.doApplyAsChar(t));
	}

	// 
	// 

	/** Converts to non-throwing variant (if required). */
	@Nonnull
	default LToCharFunction nestingToCharFunc() {
		return this::nestingDoApplyAsChar;
	}

	/** Converts to throwing variant (RuntimeException). */
	@Nonnull
	default LToCharFunctionX nestingToCharFuncX() {
		return this::nestingDoApplyAsChar;
	}

	/** 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 LToCharFunction shovingToCharFunc() {
		return this::shovingDoApplyAsChar;
	}

	/** 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 LToCharFunctionX shovingToCharFuncX() {
		return this::shovingDoApplyAsChar;
	}

	// 

	// 

	/** Converts to function that handles exceptions according to the instructions. */
	@Nonnull
	default LToCharFunction handleToCharFunc(@Nonnull HandlingInstructions handling) {
		return t -> this.handlingDoApplyAsChar(t, handling);
	}

	/** Converts to function that handles exceptions according to the instructions. */
	@Nonnull
	default  LToCharFunctionX handleToCharFuncX(@Nonnull HandlingInstructions handling) {
		return t -> this.handlingDoApplyAsChar(t, handling);
	}

	// 

}