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.action.LAction 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.action;
import javax.annotation.Nonnull; // NOSONAR
import javax.annotation.Nullable; // NOSONAR
import java.util.Objects;// NOSONAR
import java.util.function.Predicate; //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.*;
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.function.*; // NOSONAR
import eu.lunisolar.magma.func.supplier.*; // NOSONAR
import eu.lunisolar.magma.func.tuple.*; // NOSONAR
import java.util.function.*; // NOSONAR
/**
* LAction is a replacement for Runnable.
*
* - offers default methods
* - do not rise warnings about Runnable being call directly
* - two versions (throwing and non-throwing) have conversion methods that mirrors each other)
*
* Non-throwing functional interface (lambda) LAction for Java 8.
*
* Type: action
*
* Domain (lvl: 0): none
*
* Co-domain: none
*
*/
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LAction extends Runnable, MetaAction, MetaInterface.NonThrowing, Codomain, Domain0 {
String DESCRIPTION = "LAction: void execute()";
/**
* Default implementation for JRE method that calls exception nesting method.
* @deprecated Calling this method via LAction interface should be discouraged.
*/
@Override
@Deprecated
default void run() {
this.execute();
}
// void execute() ;
default void execute() {
// nestingExecute();
try {
this.executeX();
} catch (Throwable e) { // NOSONAR
throw Handling.nestCheckedAndThrow(e);
}
}
/**
* Implement this, but call execute()
*/
void executeX() throws Throwable;
default LTuple.Void tupleExecute(LTuple.Void args) {
execute();
return LTuple.Void.INSTANCE;
}
/** Function call that handles exceptions according to the instructions. */
default void handlingExecute(HandlingInstructions handling) {
try {
this.executeX();
} catch (Throwable e) { // NOSONAR
throw Handler.handleOrNest(e, handling);
}
}
default LAction handling(HandlingInstructions handling) {
return () -> handlingExecute(handling);
}
default void execute(@Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
try {
this.executeX();
} catch (Throwable e) { // NOSONAR
throw Handling.wrap(e, exF, newMessage, messageParams);
}
}
default LAction trying(@Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
return () -> execute(exF, newMessage, messageParams);
}
default void execute(@Nonnull ExWF exF) {
try {
this.executeX();
} catch (Throwable e) { // NOSONAR
throw Handling.wrap(e, exF);
}
}
default LAction trying(@Nonnull ExWF exF) {
return () -> execute(exF);
}
default void executeThen(@Nonnull LConsumer handler) {
try {
this.executeX();
} catch (Throwable e) { // NOSONAR
Handling.handleErrors(e);
handler.accept(e);
}
}
default LAction tryingThen(@Nonnull LConsumer handler) {
return () -> executeThen(handler);
}
/** Function call that handles exceptions by always nesting checked exceptions and propagating the others as is. */
default void nestingExecute() {
try {
this.executeX();
} 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 shovingExecute() {
try {
this.executeX();
} catch (Throwable e) { // NOSONAR
throw Handling.shoveIt(e);
}
}
static void handlingExecute(LAction func, HandlingInstructions handling) { // <-
Null.nonNullArg(func, "func");
func.handlingExecute(handling);
}
static void tryExecute(LAction func) {
Null.nonNullArg(func, "func");
func.nestingExecute();
}
static void tryExecute(LAction func, @Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
Null.nonNullArg(func, "func");
func.execute(exF, newMessage, messageParams);
}
static void tryExecute(LAction func, @Nonnull ExWF exF) {
Null.nonNullArg(func, "func");
func.execute(exF);
}
static void tryExecuteThen(LAction func, @Nonnull LConsumer handler) {
Null.nonNullArg(func, "func");
func.executeThen(handler);
}
default void failSafeExecute(@Nonnull LAction failSafe) {
try {
execute();
} catch (Throwable e) { // NOSONAR
Handling.handleErrors(e);
failSafe.execute();
}
}
static void failSafeExecute(LAction func, @Nonnull LAction failSafe) {
Null.nonNullArg(failSafe, "failSafe");
if (func == null) {
failSafe.execute();
} else {
func.failSafeExecute(failSafe);
}
}
static LAction failSafe(LAction func, @Nonnull LAction failSafe) {
Null.nonNullArg(failSafe, "failSafe");
return () -> failSafeExecute(func, failSafe);
}
/** Returns description of the functional interface. */
@Nonnull
default String functionalInterfaceDescription() {
return LAction.DESCRIPTION;
}
/** From-To. Intended to be used with non-capturing lambda. */
public static void fromTo(int min_i, int max_i, LAction func) {
Null.nonNullArg(func, "func");
if (min_i <= max_i) {
for (int i = min_i; i <= max_i; i++) {
func.execute();
}
} else {
for (int i = min_i; i >= max_i; i--) {
func.execute();
}
}
}
/** From-To. Intended to be used with non-capturing lambda. */
public static void fromTill(int min_i, int max_i, LAction func) {
Null.nonNullArg(func, "func");
if (min_i <= max_i) {
for (int i = min_i; i < max_i; i++) {
func.execute();
}
} else {
for (int i = min_i; i > max_i; i--) {
func.execute();
}
}
}
/** From-To. Intended to be used with non-capturing lambda. */
public static void times(int max_i, LAction func) {
if (max_i < 0)
return;
fromTill(0, max_i, func);
}
/** Convenient method in case lambda expression is ambiguous for the compiler (that might happen for overloaded methods accepting different interfaces). */
@Nonnull
static LAction act(final @Nonnull LAction lambda) {
Null.nonNullArg(lambda, "lambda");
return lambda;
}
@Nonnull
static LAction recursive(final @Nonnull LFunction selfLambda) {
final LActionSingle single = new LActionSingle();
LAction func = selfLambda.apply(single);
single.target = func;
return func;
}
final class LActionSingle implements LSingle, LAction {
private LAction target = null;
@Override
public void executeX() throws Throwable {
target.executeX();
}
@Override
public LAction value() {
return target;
}
}
@Nonnull
static LAction actThrowing(final @Nonnull ExF exF) {
Null.nonNullArg(exF, "exF");
return () -> {
throw exF.produce();
};
}
@Nonnull
static LAction actThrowing(final String message, final @Nonnull ExMF exF) {
Null.nonNullArg(exF, "exF");
return () -> {
throw exF.produce(message);
};
}
static void call(final @Nonnull LAction lambda) {
Null.nonNullArg(lambda, "lambda");
lambda.execute();
}
//
/** Wraps JRE instance. */
@Nonnull
static LAction wrap(final Runnable other) {
return other::run;
}
//
//
/** Safe instance. */
@Nonnull
static LAction safe() {
return LAction::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 LAction safe(final @Nullable LAction 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;
}
}
//
//
/** Combines two LAction together in a order. */
@Nonnull
default LAction andThen(@Nonnull LAction after) {
Null.nonNullArg(after, "after");
return () -> {
this.execute();
after.execute();
};
}
//
//
//
/** You can use this as a reference method whenever nothing should be done. */
public static void doNothing() {
// NOSONAR
}
}
