eu.lunisolar.magma.func.function.from.LIntFunction 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.function.from;
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.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.*; // NOSONAR
import eu.lunisolar.magma.func.tuple.*; // NOSONAR
import java.util.function.*; // NOSONAR
import java.util.*; // NOSONAR
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) LIntFunction for Java 8.
*
* Type: function
*
* Domain (lvl: 1): int a
*
* Co-domain: R
*
*/
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LIntFunction extends IntFunction, MetaFunction, MetaInterface.NonThrowing, Codomain>, Domain1 { // NOSONAR
String DESCRIPTION = "LIntFunction: R apply(int a)";
@Nullable
// R apply(int a) ;
default R apply(int a) {
// return nestingApply(a);
try {
return this.applyX(a);
} catch (Throwable e) { // NOSONAR
throw Handling.nestCheckedAndThrow(e);
}
}
/**
* Implement this, but call apply(int a)
*/
R applyX(int a) throws Throwable;
default R tupleApply(LIntSingle args) {
return apply(args.value());
}
/** Function call that handles exceptions according to the instructions. */
default R handlingApply(int a, HandlingInstructions handling) {
try {
return this.applyX(a);
} catch (Throwable e) { // NOSONAR
throw Handler.handleOrNest(e, handling);
}
}
default LIntFunction handling(HandlingInstructions handling) {
return a -> handlingApply(a, handling);
}
default R apply(int a, @Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
try {
return this.applyX(a);
} catch (Throwable e) { // NOSONAR
throw Handling.wrap(e, exF, newMessage, messageParams);
}
}
default LIntFunction trying(@Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
return a -> apply(a, exF, newMessage, messageParams);
}
default R apply(int a, @Nonnull ExWF exF) {
try {
return this.applyX(a);
} catch (Throwable e) { // NOSONAR
throw Handling.wrap(e, exF);
}
}
default LIntFunction trying(@Nonnull ExWF exF) {
return a -> apply(a, exF);
}
default R applyThen(int a, @Nonnull LFunction handler) {
try {
return this.applyX(a);
} catch (Throwable e) { // NOSONAR
Handling.handleErrors(e);
return handler.apply(e);
}
}
default LIntFunction tryingThen(@Nonnull LFunction handler) {
return a -> applyThen(a, handler);
}
/** Function call that handles exceptions by always nesting checked exceptions and propagating the others as is. */
default R nestingApply(int a) {
try {
return this.applyX(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 R shovingApply(int a) {
try {
return this.applyX(a);
} catch (Throwable e) { // NOSONAR
throw Handling.shoveIt(e);
}
}
static R handlingApply(int a, LIntFunction func, HandlingInstructions handling) { // <-
Null.nonNullArg(func, "func");
return func.handlingApply(a, handling);
}
static R tryApply(int a, LIntFunction func) {
Null.nonNullArg(func, "func");
return func.nestingApply(a);
}
static R tryApply(int a, LIntFunction func, @Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
Null.nonNullArg(func, "func");
return func.apply(a, exF, newMessage, messageParams);
}
static R tryApply(int a, LIntFunction func, @Nonnull ExWF exF) {
Null.nonNullArg(func, "func");
return func.apply(a, exF);
}
static R tryApplyThen(int a, LIntFunction func, @Nonnull LFunction handler) {
Null.nonNullArg(func, "func");
return func.applyThen(a, handler);
}
default R failSafeApply(int a, @Nonnull LIntFunction failSafe) {
try {
return apply(a);
} catch (Throwable e) { // NOSONAR
Handling.handleErrors(e);
return failSafe.apply(a);
}
}
static R failSafeApply(int a, LIntFunction func, @Nonnull LIntFunction failSafe) {
Null.nonNullArg(failSafe, "failSafe");
if (func == null) {
return failSafe.apply(a);
} else {
return func.failSafeApply(a, failSafe);
}
}
static LIntFunction failSafe(LIntFunction func, @Nonnull LIntFunction failSafe) {
Null.nonNullArg(failSafe, "failSafe");
return a -> failSafeApply(a, func, failSafe);
}
LSupplier NULL_VALUE_MESSAGE_SUPPLIER = () -> "Evaluated value by nonNullApply() method cannot be null (" + DESCRIPTION + ").";
/** Function call that ensures the result is not null */
@Nonnull
default R nonNullApply(int a) {
return Null.requireNonNull(apply(a), NULL_VALUE_MESSAGE_SUPPLIER);
}
/** Returns description of the functional interface. */
@Nonnull
default String functionalInterfaceDescription() {
return LIntFunction.DESCRIPTION;
}
/** From-To. Intended to be used with non-capturing lambda. */
public static void fromTo(int min_a, int max_a, LIntFunction func) {
Null.nonNullArg(func, "func");
if (min_a <= max_a) {
for (int a = min_a; a <= max_a; a++) {
func.apply(a);
}
} else {
for (int a = min_a; a >= max_a; a--) {
func.apply(a);
}
}
}
/** From-To. Intended to be used with non-capturing lambda. */
public static void fromTill(int min_a, int max_a, LIntFunction func) {
Null.nonNullArg(func, "func");
if (min_a <= max_a) {
for (int a = min_a; a < max_a; a++) {
func.apply(a);
}
} else {
for (int a = min_a; a > max_a; a--) {
func.apply(a);
}
}
}
/** From-To. Intended to be used with non-capturing lambda. */
public static void times(int max_a, LIntFunction func) {
if (max_a < 0)
return;
fromTill(0, max_a, func);
}
/** Cast that removes generics. */
public default LIntFunction untyped() {
return this;
}
/** Cast that replace generics. */
public default LIntFunction cast() {
return untyped();
}
/** Cast that replace generics. */
public static LIntFunction cast(LIntFunction function) {
return (LIntFunction) function;
}
/** Captures arguments but delays the evaluation. */
default LSupplier capture(int a) {
return () -> this.apply(a);
}
/** Creates function that always returns the same value. */
static LIntFunction constant(R r) {
return a -> r;
}
/** Convenient method in case lambda expression is ambiguous for the compiler (that might happen for overloaded methods accepting different interfaces). */
@Nonnull
static LIntFunction intFunc(final @Nonnull LIntFunction lambda) {
Null.nonNullArg(lambda, "lambda");
return lambda;
}
@Nonnull
static LIntFunction recursive(final @Nonnull LFunction, LIntFunction> selfLambda) {
final LIntFunctionSingle single = new LIntFunctionSingle();
LIntFunction func = selfLambda.apply(single);
single.target = func;
return func;
}
final class LIntFunctionSingle implements LSingle>, LIntFunction {
private LIntFunction target = null;
@Override
public R applyX(int a) throws Throwable {
return target.applyX(a);
}
@Override
public LIntFunction value() {
return target;
}
}
@Nonnull
static LIntFunction intFuncThrowing(final @Nonnull ExF exF) {
Null.nonNullArg(exF, "exF");
return a -> {
throw exF.produce();
};
}
@Nonnull
static LIntFunction intFuncThrowing(final String message, final @Nonnull ExMF exF) {
Null.nonNullArg(exF, "exF");
return a -> {
throw exF.produce(message);
};
}
static R call(int a, final @Nonnull LIntFunction lambda) {
Null.nonNullArg(lambda, "lambda");
return lambda.apply(a);
}
//
/** Wraps JRE instance. */
@Nonnull
static LIntFunction wrap(final IntFunction other) {
return other::apply;
}
//
//
/** Safe instance. That always returns the same value (as produce). */
@Nonnull
static LIntFunction safe() {
return LIntFunction::produce;
}
/** 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 LIntFunction safe(final @Nullable LIntFunction 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 LIntFunction compose(@Nonnull final LIntUnaryOperator before) {
Null.nonNullArg(before, "before");
return v -> this.apply(before.applyAsInt(v));
}
public static LIntFunction composed(@Nonnull final LIntUnaryOperator before, LIntFunction after) {
return after.compose(before);
}
/** Allows to manipulate the domain of the function. */
@Nonnull
default LFunction intFuncCompose(@Nonnull final LToIntFunction super V> before) {
Null.nonNullArg(before, "before");
return v -> this.apply(before.applyAsInt(v));
}
public static LFunction composed(@Nonnull final LToIntFunction super V> before, LIntFunction after) {
return after.intFuncCompose(before);
}
//
//
/** Combines two functions together in a order. */
@Nonnull
default LIntFunction then(@Nonnull LFunction super R, ? extends V> after) {
Null.nonNullArg(after, "after");
return a -> after.apply(this.apply(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LIntConsumer thenConsume(@Nonnull LConsumer super R> after) {
Null.nonNullArg(after, "after");
return a -> after.accept(this.apply(a));
}
@Nonnull
default LIntFunction before(@Nonnull LIntConsumer before) {
Null.nonNullArg(before, "before");
return a -> {
before.accept(a);
return this.apply(a);
};
}
@Nonnull
default LIntFunction after(@Nonnull LConsumer super R> after) {
Null.nonNullArg(after, "after");
return a -> {
R result = this.apply(a);
after.accept(result);
return result;
};
}
/** Combines two functions together in a order. */
@Nonnull
default LIntToByteFunction thenToByte(@Nonnull LToByteFunction super R> after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsByte(this.apply(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LIntToSrtFunction thenToSrt(@Nonnull LToSrtFunction super R> after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsSrt(this.apply(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LIntUnaryOperator thenToInt(@Nonnull LToIntFunction super R> after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsInt(this.apply(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LIntToLongFunction thenToLong(@Nonnull LToLongFunction super R> after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsLong(this.apply(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LIntToFltFunction thenToFlt(@Nonnull LToFltFunction super R> after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsFlt(this.apply(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LIntToDblFunction thenToDbl(@Nonnull LToDblFunction super R> after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsDbl(this.apply(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LIntToCharFunction thenToChar(@Nonnull LToCharFunction super R> after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsChar(this.apply(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LIntPredicate thenToBool(@Nonnull LPredicate super R> after) {
Null.nonNullArg(after, "after");
return a -> after.test(this.apply(a));
}
//
//
//
/** Converts to function that makes sure that the result is not null. */
@Nonnull
default LIntFunction nonNullable() {
return this::nonNullApply;
}
/** Does nothing (LIntFunction) Function */
public static R produce(int a) {
return (R) Function4U.defaultObject;
}
/**
* For each element (or tuple) from arguments, calls the function and passes the result to consumer.
* Thread safety, fail-fast, fail-safety of this method is not expected.
*/
default void forEach(IndexedRead ia, C0 source, LConsumer super R> consumer) {
int size = ia.size(source);
LOiToIntFunction