eu.lunisolar.magma.func.consumer.LConsumerX Maven / Gradle / Ivy
/*
* 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) LConsumerX for Java 8.
*
* Type: consumer
*
* Domain (lvl: 1): T t
*
* Co-domain: none
*
* @see LConsumer
*/
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LConsumerX extends java.util.function.Consumer, MetaConsumer, MetaInterface.Throwing {
static final String DESCRIPTION = "LConsumerX: void doAccept(T t) throws X";
/**
* Default implementation for JRE method that calls exception nesting method.
* @deprecated Calling this method via LConsumerX interface should be discouraged.
*/
@Override
@Deprecated
default void accept(T t) {
this.nestingDoAccept(t);
}
void doAccept(T t) throws X;
/** Function call that handles exceptions by always nesting checked exceptions and propagating the otheres as is. */
default void nestingDoAccept(T t) {
try {
this.doAccept(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 void shovingDoAccept(T t) {
((LConsumerX) this).doAccept(t);
}
/** Function call that handles exceptions according to the instructions. */
default void handlingDoAccept(T t, HandlingInstructions handling) throws Y {
try {
this.doAccept(t);
} catch (Throwable e) { // NOSONAR
throw Handler.handleOrNest(e, handling);
}
}
/** Returns description of the functional interface. */
@Nonnull
default String functionalInterfaceDescription() {
return LConsumerX.DESCRIPTION;
}
/** Captures arguments but delays the evaluation. */
default LActionX captureCons(T t) {
return () -> this.doAccept(t);
}
/** Convenient method in case lambda expression is ambiguous for the compiler (that might happen for overloaded methods accepting different interfaces). */
@Nonnull
static LConsumerX lX(final @Nonnull LConsumerX 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 LConsumerX lX(@Nonnull Class xClass, final @Nonnull LConsumerX lambda) {
Null.nonNullArg(lambda, "lambda");
return lambda;
}
//
/** Wraps JRE instance. */
@Nonnull
static LConsumerX wrap(final java.util.function.Consumer other) {
return other::accept;
}
/** Wraps opposite (throwing vs non-throwing) instance. */
@Nonnull
static LConsumerX wrapX(final @Nonnull LConsumer other) {
return (LConsumerX) other;
}
//
//
/** Allows to manipulate the domain of the function. */
@Nonnull
default LConsumerX consCompose(@Nonnull final LFunctionX before1) {
Null.nonNullArg(before1, "before1");
return v1 -> this.doAccept(before1.doApply(v1));
}
//
//
/** Combines two consumers together in a order. */
@Nonnull
default LConsumerX andThen(@Nonnull LConsumerX after) {
Null.nonNullArg(after, "after");
return t -> {
this.doAccept(t);
after.doAccept(t);
};
}
// //
/** Converts to non-throwing variant (if required). */
@Nonnull
default LConsumer nestingCons() {
return this::nestingDoAccept;
}
/** Converts to throwing variant (RuntimeException). */
@Nonnull
default LConsumerX nestingConsX() {
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 LConsumer shovingCons() {
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 LConsumerX shovingConsX() {
return this::shovingDoAccept;
}
//
//
/** Converts to function that handles exceptions according to the instructions. */
@Nonnull
default LConsumer handleCons(@Nonnull HandlingInstructions handling) {
return t -> this.handlingDoAccept(t, handling);
}
/** Converts to function that handles exceptions according to the instructions. */
@Nonnull
default LConsumerX handleConsX(@Nonnull HandlingInstructions handling) {
return t -> this.handlingDoAccept(t, handling);
}
//
}