eu.lunisolar.magma.func.supplier.LSupplierX 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.supplier;
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.builder.*; // NOSONAR
import eu.lunisolar.magma.basics.exceptions.*; // 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.*; // 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) LSupplierX for Java 8.
*
* Type: supplier
*
* Domain (lvl: 0): none
*
* Co-domain: R
*
* @see LSupplier
*/
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LSupplierX extends java.util.function.Supplier, MetaSupplier, MetaInterface.Throwing {
static final String DESCRIPTION = "LSupplierX: R doGet() throws X";
/**
* Default implementation for JRE method that calls exception nesting method.
* @deprecated Calling this method via LSupplierX interface should be discouraged.
*/
@Override
@Deprecated
default R get() {
return this.nestingDoGet();
}
@Nullable
R doGet() throws X;
/** Function call that handles exceptions by always nesting checked exceptions and propagating the otheres as is. */
default R nestingDoGet() {
try {
return this.doGet();
} 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 R shovingDoGet() {
return ((LSupplierX) this).doGet();
}
/** Function call that handles exceptions according to the instructions. */
default R handlingDoGet(HandlingInstructions handling) throws Y {
try {
return this.doGet();
} catch (Throwable e) { // NOSONAR
throw Handler.handleOrNest(e, handling);
}
}
static final LSupplier NULL_VALUE_MESSAGE_SUPPLIER = () -> "Evaluated value by nonNullDoGet() method cannot be null (" + DESCRIPTION + ").";
/** Function call that ensures the result is not null */
@Nonnull
default R nonNullDoGet() throws X {
return Null.requireNonNull(doGet(), NULL_VALUE_MESSAGE_SUPPLIER);
}
/** Returns description of the functional interface. */
@Nonnull
default String functionalInterfaceDescription() {
return LSupplierX.DESCRIPTION;
}
/** Creates function that always returns the same value. */
static LSupplierX of(R r) {
return () -> r;
}
/** Convenient method in case lambda expression is ambiguous for the compiler (that might happen for overloaded methods accepting different interfaces). */
@Nonnull
static LSupplierX lX(final @Nonnull LSupplierX 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 LSupplierX lX(@Nonnull Class xClass, final @Nonnull LSupplierX lambda) {
Null.nonNullArg(lambda, "lambda");
return lambda;
}
//
/** Wraps JRE instance. */
@Nonnull
static LSupplierX wrap(final java.util.function.Supplier other) {
return other::get;
}
/** Wraps opposite (throwing vs non-throwing) instance. */
@Nonnull
static LSupplierX wrapX(final @Nonnull LSupplier other) {
return (LSupplierX) other;
}
//
//
/** Combines two suppliers together in a order. */
@Nonnull
default LSupplierX toSupplier(@Nonnull LFunctionX after) {
Null.nonNullArg(after, "after");
return () -> after.doApply(this.doGet());
}
/** Combines two suppliers together in a order. */
@Nonnull
default LActionX toAction(@Nonnull LConsumerX after) {
Null.nonNullArg(after, "after");
return () -> after.doAccept(this.doGet());
}
/** Combines two suppliers together in a order. */
@Nonnull
default LByteSupplierX toByteSupplier(@Nonnull LToByteFunctionX after) {
Null.nonNullArg(after, "after");
return () -> after.doApplyAsByte(this.doGet());
}
/** Combines two suppliers together in a order. */
@Nonnull
default LShortSupplierX toShortSupplier(@Nonnull LToShortFunctionX after) {
Null.nonNullArg(after, "after");
return () -> after.doApplyAsShort(this.doGet());
}
/** Combines two suppliers together in a order. */
@Nonnull
default LIntSupplierX toIntSupplier(@Nonnull LToIntFunctionX after) {
Null.nonNullArg(after, "after");
return () -> after.doApplyAsInt(this.doGet());
}
/** Combines two suppliers together in a order. */
@Nonnull
default LLongSupplierX toLongSupplier(@Nonnull LToLongFunctionX after) {
Null.nonNullArg(after, "after");
return () -> after.doApplyAsLong(this.doGet());
}
/** Combines two suppliers together in a order. */
@Nonnull
default LFloatSupplierX toFloatSupplier(@Nonnull LToFloatFunctionX after) {
Null.nonNullArg(after, "after");
return () -> after.doApplyAsFloat(this.doGet());
}
/** Combines two suppliers together in a order. */
@Nonnull
default LDoubleSupplierX toDoubleSupplier(@Nonnull LToDoubleFunctionX after) {
Null.nonNullArg(after, "after");
return () -> after.doApplyAsDouble(this.doGet());
}
/** Combines two suppliers together in a order. */
@Nonnull
default LCharSupplierX toCharSupplier(@Nonnull LToCharFunctionX after) {
Null.nonNullArg(after, "after");
return () -> after.doApplyAsChar(this.doGet());
}
/** Combines two suppliers together in a order. */
@Nonnull
default LBoolSupplierX toBoolSupplier(@Nonnull LPredicateX after) {
Null.nonNullArg(after, "after");
return () -> after.doTest(this.doGet());
}
//
//
/** Converts to non-throwing variant (if required). */
@Nonnull
default LSupplier nestingSup() {
return this::nestingDoGet;
}
/** Converts to throwing variant (RuntimeException). */
@Nonnull
default LSupplierX nestingSupX() {
return this::nestingDoGet;
}
/** 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 LSupplier shovingSup() {
return this::shovingDoGet;
}
/** 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 LSupplierX shovingSupX() {
return this::shovingDoGet;
}
//
/** Converts to function that makes sure that the result is not null. */
@Nonnull
default LSupplierX nonNullSup() {
return this::nonNullDoGet;
}
//
/** Converts to function that handles exceptions according to the instructions. */
@Nonnull
default LSupplier handleSup(@Nonnull HandlingInstructions handling) {
return () -> this.handlingDoGet(handling);
}
/** Converts to function that handles exceptions according to the instructions. */
@Nonnull
default LSupplierX handleSupX(@Nonnull HandlingInstructions handling) {
return () -> this.handlingDoGet(handling);
}
//
}