eu.lunisolar.magma.func.consumer.LConsumer Maven / Gradle / Ivy
/*
* 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.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.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.consumer.*; // NOSONAR
import eu.lunisolar.magma.func.*; // NOSONAR
import eu.lunisolar.magma.func.tuple.*; // NOSONAR
import java.util.function.*; // NOSONAR
import java.util.*;
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) LConsumer for Java 8.
*
* Type: consumer
*
* Domain (lvl: 1): T a
*
* Co-domain: none
*
*/
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LConsumer extends Consumer, MetaConsumer, MetaInterface.NonThrowing, Codomain, Domain1> {
String DESCRIPTION = "LConsumer: void accept(T a)";
// void accept(T a) ;
default void accept(T a) {
// nestingAccept(a);
try {
this.acceptX(a);
} catch (Throwable e) { // NOSONAR
throw Handling.nestCheckedAndThrow(e);
}
}
/**
* Implement this, but call accept(T a)
*/
void acceptX(T a) throws Throwable;
default LTuple.Void tupleAccept(LSingle args) {
accept(args.value());
return LTuple.Void.INSTANCE;
}
/** Function call that handles exceptions according to the instructions. */
default void handlingAccept(T a, HandlingInstructions handling) {
try {
this.acceptX(a);
} catch (Throwable e) { // NOSONAR
throw Handler.handleOrNest(e, handling);
}
}
default LConsumer handling(HandlingInstructions handling) {
return a -> handlingAccept(a, handling);
}
default void accept(T a, @Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
try {
this.acceptX(a);
} catch (Throwable e) { // NOSONAR
throw Handling.wrap(e, exF, newMessage, messageParams);
}
}
default LConsumer trying(@Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
return a -> accept(a, exF, newMessage, messageParams);
}
default void accept(T a, @Nonnull ExWF exF) {
try {
this.acceptX(a);
} catch (Throwable e) { // NOSONAR
throw Handling.wrap(e, exF);
}
}
default LConsumer trying(@Nonnull ExWF exF) {
return a -> accept(a, exF);
}
default void acceptThen(T a, @Nonnull LConsumer handler) {
try {
this.acceptX(a);
} catch (Throwable e) { // NOSONAR
Handling.handleErrors(e);
handler.accept(e);
}
}
default LConsumer tryingThen(@Nonnull LConsumer handler) {
return a -> acceptThen(a, handler);
}
/** Function call that handles exceptions by always nesting checked exceptions and propagating the others as is. */
default void nestingAccept(T a) {
try {
this.acceptX(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 void shovingAccept(T a) {
try {
this.acceptX(a);
} catch (Throwable e) { // NOSONAR
throw Handling.shoveIt(e);
}
}
static void handlingAccept(T a, LConsumer func, HandlingInstructions handling) { // <-
Null.nonNullArg(func, "func");
func.handlingAccept(a, handling);
}
static void tryAccept(T a, LConsumer func) {
Null.nonNullArg(func, "func");
func.nestingAccept(a);
}
static void tryAccept(T a, LConsumer func, @Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
Null.nonNullArg(func, "func");
func.accept(a, exF, newMessage, messageParams);
}
static void tryAccept(T a, LConsumer func, @Nonnull ExWF exF) {
Null.nonNullArg(func, "func");
func.accept(a, exF);
}
static void tryAcceptThen(T a, LConsumer func, @Nonnull LConsumer handler) {
Null.nonNullArg(func, "func");
func.acceptThen(a, handler);
}
default void failSafeAccept(T a, @Nonnull LConsumer failSafe) {
try {
accept(a);
} catch (Throwable e) { // NOSONAR
Handling.handleErrors(e);
failSafe.accept(a);
}
}
static void failSafeAccept(T a, LConsumer func, @Nonnull LConsumer failSafe) {
Null.nonNullArg(failSafe, "failSafe");
if (func == null) {
failSafe.accept(a);
} else {
func.failSafeAccept(a, failSafe);
}
}
static LConsumer failSafe(LConsumer func, @Nonnull LConsumer failSafe) {
Null.nonNullArg(failSafe, "failSafe");
return a -> failSafeAccept(a, func, failSafe);
}
/** Returns description of the functional interface. */
@Nonnull
default String functionalInterfaceDescription() {
return LConsumer.DESCRIPTION;
}
/** From-To. Intended to be used with non-capturing lambda. */
public static void fromTo(int min_i, int max_i, T a, LConsumer func) {
Null.nonNullArg(func, "func");
if (min_i <= max_i) {
for (int i = min_i; i <= max_i; i++) {
func.accept(a);
}
} else {
for (int i = min_i; i >= max_i; i--) {
func.accept(a);
}
}
}
/** From-To. Intended to be used with non-capturing lambda. */
public static void fromTill(int min_i, int max_i, T a, LConsumer func) {
Null.nonNullArg(func, "func");
if (min_i <= max_i) {
for (int i = min_i; i < max_i; i++) {
func.accept(a);
}
} else {
for (int i = min_i; i > max_i; i--) {
func.accept(a);
}
}
}
/** From-To. Intended to be used with non-capturing lambda. */
public static void times(int max_i, T a, LConsumer func) {
if (max_i < 0)
return;
fromTill(0, max_i, a, func);
}
/** Cast that removes generics. */
public default LConsumer untyped() {
return this;
}
/** Cast that replace generics. */
public default LConsumer cast() {
return untyped();
}
/** Cast that replace generics. */
public static LConsumer cast(LConsumer function) {
return (LConsumer) function;
}
/** Captures arguments but delays the evaluation. */
default LAction capture(T a) {
return () -> this.accept(a);
}
/** Convenient method in case lambda expression is ambiguous for the compiler (that might happen for overloaded methods accepting different interfaces). */
@Nonnull
static LConsumer cons(final @Nonnull LConsumer lambda) {
Null.nonNullArg(lambda, "lambda");
return lambda;
}
@Nonnull
static LConsumer recursive(final @Nonnull LFunction, LConsumer> selfLambda) {
final LConsumerSingle single = new LConsumerSingle();
LConsumer func = selfLambda.apply(single);
single.target = func;
return func;
}
final class LConsumerSingle implements LSingle>, LConsumer {
private LConsumer target = null;
@Override
public void acceptX(T a) throws Throwable {
target.acceptX(a);
}
@Override
public LConsumer value() {
return target;
}
}
@Nonnull
static LConsumer consThrowing(final @Nonnull ExF exF) {
Null.nonNullArg(exF, "exF");
return a -> {
throw exF.produce();
};
}
@Nonnull
static LConsumer consThrowing(final String message, final @Nonnull ExMF exF) {
Null.nonNullArg(exF, "exF");
return a -> {
throw exF.produce(message);
};
}
static void call(T a, final @Nonnull LConsumer lambda) {
Null.nonNullArg(lambda, "lambda");
lambda.accept(a);
}
//
/** Wraps JRE instance. */
@Nonnull
static LConsumer wrap(final Consumer other) {
return other::accept;
}
//
//
/** Safe instance. */
@Nonnull
static LConsumer safe() {
return LConsumer::doNothing;
}
/** 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 LConsumer safe(final @Nullable LConsumer 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 LConsumer compose(@Nonnull final LFunction super V, ? extends T> before) {
Null.nonNullArg(before, "before");
return v -> this.accept(before.apply(v));
}
public static LConsumer composed(@Nonnull final LFunction super V, ? extends T> before, LConsumer after) {
return after.compose(before);
}
//
//
/** Combines two LConsumer together in a order. */
@Nonnull
default LConsumer andThen(@Nonnull LConsumer super T> after) {
Null.nonNullArg(after, "after");
return a -> {
this.accept(a);
after.accept(a);
};
}
//
//
//
/** Does nothing (LConsumer) */
public static void doNothing(T a) {
// NOSONAR
}
/**
* For each element (or tuple) from arguments, calls the consumer.
* Thread safety, fail-fast, fail-safety of this method is not expected.
* @returns iterations count
*/
public static int forEach(IndexedRead> ia, C0 source, LConsumer super T> consumer) {
int size = ia.size(source);
LOiFunction