Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
eu.lunisolar.magma.func.function.LFunction 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;
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) LFunction for Java 8.
*
* Type: function
*
* Domain (lvl: 1): T a
*
* Co-domain: R
*
* Special case of function that corresponds to expressions like (iterator) -> Iterator::next
*
*/
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LFunction extends Function, MetaFunction, MetaInterface.NonThrowing, OFunction>, Codomain>, Domain1> { // NOSONAR
String DESCRIPTION = "LFunction: R apply(T a)";
@Nullable
// R apply(T a) ;
default R apply(T a) {
// return nestingApply(a);
try {
return this.applyX(a);
} catch (Throwable e) { // NOSONAR
throw Handling.nestCheckedAndThrow(e);
}
}
/**
* Implement this, but call apply(T a)
*/
R applyX(T a) throws Throwable;
default R tupleApply(LSingle args) {
return apply(args.value());
}
/** Function call that handles exceptions according to the instructions. */
default R handlingApply(T a, HandlingInstructions handling) {
try {
return this.applyX(a);
} catch (Throwable e) { // NOSONAR
throw Handler.handleOrNest(e, handling);
}
}
default LFunction handling(HandlingInstructions handling) {
return a -> handlingApply(a, handling);
}
default R apply(T 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 LFunction trying(@Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
return a -> apply(a, exF, newMessage, messageParams);
}
default R apply(T a, @Nonnull ExWF exF) {
try {
return this.applyX(a);
} catch (Throwable e) { // NOSONAR
throw Handling.wrap(e, exF);
}
}
default LFunction trying(@Nonnull ExWF exF) {
return a -> apply(a, exF);
}
default R applyThen(T a, @Nonnull LFunction handler) {
try {
return this.applyX(a);
} catch (Throwable e) { // NOSONAR
Handling.handleErrors(e);
return handler.apply(e);
}
}
default LFunction 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(T 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(T a) {
try {
return this.applyX(a);
} catch (Throwable e) { // NOSONAR
throw Handling.shoveIt(e);
}
}
static R handlingApply(T a, LFunction func, HandlingInstructions handling) { // <-
Null.nonNullArg(func, "func");
return func.handlingApply(a, handling);
}
static R tryApply(T a, LFunction func) {
Null.nonNullArg(func, "func");
return func.nestingApply(a);
}
static R tryApply(T a, LFunction func, @Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
Null.nonNullArg(func, "func");
return func.apply(a, exF, newMessage, messageParams);
}
static R tryApply(T a, LFunction func, @Nonnull ExWF exF) {
Null.nonNullArg(func, "func");
return func.apply(a, exF);
}
static R tryApplyThen(T a, LFunction func, @Nonnull LFunction handler) {
Null.nonNullArg(func, "func");
return func.applyThen(a, handler);
}
default R failSafeApply(T a, @Nonnull LFunction failSafe) {
try {
return apply(a);
} catch (Throwable e) { // NOSONAR
Handling.handleErrors(e);
return failSafe.apply(a);
}
}
static R failSafeApply(T a, LFunction func, @Nonnull LFunction failSafe) {
Null.nonNullArg(failSafe, "failSafe");
if (func == null) {
return failSafe.apply(a);
} else {
return func.failSafeApply(a, failSafe);
}
}
static LFunction failSafe(LFunction func, @Nonnull LFunction 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(T a) {
return Null.requireNonNull(apply(a), NULL_VALUE_MESSAGE_SUPPLIER);
}
/** Returns description of the functional interface. */
@Nonnull
default String functionalInterfaceDescription() {
return LFunction.DESCRIPTION;
}
/** From-To. Intended to be used with non-capturing lambda. */
public static void fromTo(int min_i, int max_i, T a, LFunction func) {
Null.nonNullArg(func, "func");
if (min_i <= max_i) {
for (int i = min_i; i <= max_i; i++) {
func.apply(a);
}
} else {
for (int i = min_i; i >= max_i; i--) {
func.apply(a);
}
}
}
/** From-To. Intended to be used with non-capturing lambda. */
public static void fromTill(int min_i, int max_i, T a, LFunction func) {
Null.nonNullArg(func, "func");
if (min_i <= max_i) {
for (int i = min_i; i < max_i; i++) {
func.apply(a);
}
} else {
for (int i = min_i; i > max_i; i--) {
func.apply(a);
}
}
}
/** From-To. Intended to be used with non-capturing lambda. */
public static void times(int max_i, T a, LFunction func) {
if (max_i < 0)
return;
fromTill(0, max_i, a, func);
}
/** Cast that removes generics. */
public default LFunction untyped() {
return this;
}
/** Cast that replace generics. */
public default LFunction cast() {
return untyped();
}
/** Cast that replace generics. */
public static LFunction cast(LFunction function) {
return (LFunction) function;
}
/** Captures arguments but delays the evaluation. */
default LSupplier capture(T a) {
return () -> this.apply(a);
}
/** Creates function that always returns the same value. */
static LFunction 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 LFunction func(final @Nonnull LFunction lambda) {
Null.nonNullArg(lambda, "lambda");
return lambda;
}
@Nonnull
static LFunction recursive(final @Nonnull LFunction, LFunction> selfLambda) {
final LFunctionSingle single = new LFunctionSingle();
LFunction func = selfLambda.apply(single);
single.target = func;
return func;
}
final class LFunctionSingle implements LSingle>, LFunction {
private LFunction target = null;
@Override
public R applyX(T a) throws Throwable {
return target.applyX(a);
}
@Override
public LFunction value() {
return target;
}
}
@Nonnull
static LFunction funcThrowing(final @Nonnull ExF exF) {
Null.nonNullArg(exF, "exF");
return a -> {
throw exF.produce();
};
}
@Nonnull
static LFunction funcThrowing(final String message, final @Nonnull ExMF exF) {
Null.nonNullArg(exF, "exF");
return a -> {
throw exF.produce(message);
};
}
static R call(T a, final @Nonnull LFunction lambda) {
Null.nonNullArg(lambda, "lambda");
return lambda.apply(a);
}
//
/** Wraps JRE instance. */
@Nonnull
static LFunction wrap(final Function other) {
return other::apply;
}
//
//
/** Safe instance. That always returns the same value (as produce). */
@Nonnull
static LFunction safe() {
return LFunction::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 LFunction safe(final @Nullable LFunction 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 LFunction compose(@Nonnull final LFunction before) {
Null.nonNullArg(before, "before");
return v -> this.apply(before.apply(v));
}
public static LFunction composed(@Nonnull final LFunction before, LFunction after) {
return after.compose(before);
}
//
//
/** Combines two functions together in a order. */
@Nonnull
default LFunction then(@Nonnull LFunction after) {
Null.nonNullArg(after, "after");
return a -> after.apply(this.apply(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LConsumer thenConsume(@Nonnull LConsumer after) {
Null.nonNullArg(after, "after");
return a -> after.accept(this.apply(a));
}
@Nonnull
default LFunction before(@Nonnull LConsumer before) {
Null.nonNullArg(before, "before");
return a -> {
before.accept(a);
return this.apply(a);
};
}
@Nonnull
default LFunction after(@Nonnull LConsumer 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 LToByteFunction thenToByte(@Nonnull LToByteFunction after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsByte(this.apply(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LToSrtFunction thenToSrt(@Nonnull LToSrtFunction after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsSrt(this.apply(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LToIntFunction thenToInt(@Nonnull LToIntFunction after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsInt(this.apply(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LToLongFunction thenToLong(@Nonnull LToLongFunction after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsLong(this.apply(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LToFltFunction thenToFlt(@Nonnull LToFltFunction after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsFlt(this.apply(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LToDblFunction thenToDbl(@Nonnull LToDblFunction after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsDbl(this.apply(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LToCharFunction thenToChar(@Nonnull LToCharFunction after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsChar(this.apply(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LPredicate thenToBool(@Nonnull LPredicate after) {
Null.nonNullArg(after, "after");
return a -> after.test(this.apply(a));
}
//
/** Returns a function that always returns its input argument. */
@Nonnull
static LFunction identity() {
return t -> t;
}
//
//
/** Converts to function that makes sure that the result is not null. */
@Nonnull
default LFunction nonNullable() {
return this::nonNullApply;
}
/** Does nothing (LFunction) Function */
public static R produce(T 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 consumer) {
int size = ia.size(source);
LOiFunction oiFunc0 = (LOiFunction) ia.getter();
int i = 0;
for (; i < size; i++) {
T a = oiFunc0.apply(source, i);
consumer.accept(this.apply(a));
}
}
/**
* 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 depends highly on the arguments.
*/
default void iterate(SequentialRead> sa, C0 source, LConsumer consumer) {
Object iterator0 = ((LFunction) sa.adapter()).apply(source);
LPredicate testFunc0 = (LPredicate) sa.tester();
LFunction nextFunc0 = (LFunction) sa.supplier();
while (testFunc0.test(iterator0)) {
T a = nextFunc0.apply(iterator0);
consumer.accept(this.apply(a));
}
}
}
