eu.lunisolar.magma.func.consumer.LBiConsumerX Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of magma-func Show documentation
There is a newer version: 3.0.0
/*
 * 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.consumer;

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.exceptions.*; // NOSONAR
import eu.lunisolar.magma.func.*; // 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.consumer.*; // 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) LBiConsumerX for Java 8.
 *
 * Type: consumer
 *
 * Domain (lvl: 2): T1 t1,T2 t2
 *
 * Co-domain: none
 *
 * @see LBiConsumer
 */
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LBiConsumerX extends java.util.function.BiConsumer, MetaConsumer, MetaInterface.Throwing {

	static final String DESCRIPTION = "LBiConsumerX: void doAccept(T1 t1,T2 t2) throws X";

	/**
	 * Default implementation for JRE method that calls exception nesting method.
	 * @deprecated Calling this method via LBiConsumerX interface should be discouraged.
	 */
	@Override
	@Deprecated
	default void accept(T1 t1, T2 t2) {
		this.nestingDoAccept(t1, t2);
	}

	void doAccept(T1 t1, T2 t2) throws X;

	/** Function call that handles exceptions by always nesting checked exceptions and propagating the otheres as is. */
	default void nestingDoAccept(T1 t1, T2 t2) {
		try {
			this.doAccept(t1, t2);
		} 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 void shovingDoAccept(T1 t1, T2 t2) {
		((LBiConsumerX) this).doAccept(t1, t2);
	}

	/** Function call that handles exceptions according to the instructions. */
	default  void handlingDoAccept(T1 t1, T2 t2, HandlingInstructions handling) throws Y {

		try {
			this.doAccept(t1, t2);
		} catch (Throwable e) { // NOSONAR
			throw Handler.handleOrNest(e, handling);
		}
	}

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

	/** Captures arguments but delays the evaluation. */
	default LActionX captureBiCons(T1 t1, T2 t2) {
		return () -> this.doAccept(t1, t2);
	}

	/** Captures single parameter function into this interface where only 1st parameter will be used. */
	@Nonnull
	static  LBiConsumerX accept1st(@Nonnull LConsumerX func) {
		return (t1, t2) -> func.doAccept(t1);
	}

	/** Captures single parameter function into this interface where only 2nd parameter will be used. */
	@Nonnull
	static  LBiConsumerX accept2nd(@Nonnull LConsumerX func) {
		return (t1, t2) -> func.doAccept(t2);
	}

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

	// 

	/** Wraps JRE instance. */
	@Nonnull
	static  LBiConsumerX wrap(final java.util.function.BiConsumer other) {
		return other::accept;
	}

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

	// 

	// 

	/** Allows to manipulate the domain of the function. */
	@Nonnull
	default  LBiConsumerX biConsCompose(@Nonnull final LFunctionX before1, @Nonnull final LFunctionX before2) {
		Null.nonNullArg(before1, "before1");
		Null.nonNullArg(before2, "before2");
		return (final V1 v1, final V2 v2) -> this.doAccept(before1.doApply(v1), before2.doApply(v2));
	}

	// 

	// 

	/** Combines two consumers together in a order. */
	@Nonnull
	default LBiConsumerX andThen(@Nonnull LBiConsumerX after) {
		Null.nonNullArg(after, "after");
		return (T1 t1, T2 t2) -> {
			this.doAccept(t1, t2);
			after.doAccept(t1, t2);
		};
	}

	//  // 

	/** Converts to non-throwing variant (if required). */
	@Nonnull
	default LBiConsumer nestingBiCons() {
		return this::nestingDoAccept;
	}

	/** Converts to throwing variant (RuntimeException). */
	@Nonnull
	default LBiConsumerX nestingBiConsX() {
		return this::nestingDoAccept;
	}

	/** 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 LBiConsumer shovingBiCons() {
		return this::shovingDoAccept;
	}

	/** 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 LBiConsumerX shovingBiConsX() {
		return this::shovingDoAccept;
	}

	// 

	// 

	/** Converts to function that handles exceptions according to the instructions. */
	@Nonnull
	default LBiConsumer handleBiCons(@Nonnull HandlingInstructions handling) {
		return (T1 t1, T2 t2) -> this.handlingDoAccept(t1, t2, handling);
	}

	/** Converts to function that handles exceptions according to the instructions. */
	@Nonnull
	default  LBiConsumerX handleBiConsX(@Nonnull HandlingInstructions handling) {
		return (T1 t1, T2 t2) -> this.handlingDoAccept(t1, t2, handling);
	}

	// 

}