Package org.sellcom.core.util.function

Interface ThrowingToDoubleFunction<T>

All Superinterfaces:

java.util.function.ToDoubleFunction<T>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ThrowingToDoubleFunction<T>
extends java.util.function.ToDoubleFunction<T>

Represents a function that accepts a single argument and produces a double-valued result, possibly throwing an exception.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
default double	applyAsDouble(T argument)	Applies this function to the given argument.
double	applyAsDoubleThrowing(T argument)	Applies this function to the given argument.
default java.util.function.ToDoubleFunction<T>	fallbackTo(java.util.function.ToDoubleFunction<T> fallback)	Returns a ToDoubleFunction applying the given function to the argument if this function throws an exception.
default java.util.function.ToDoubleFunction<T>	fallbackTo(java.util.function.ToDoubleFunction<T> fallback, java.util.function.Consumer<java.lang.Exception> exceptionConsumer)	Returns a ToDoubleFunction applying the given function to the argument if this function throws an exception.
default java.util.function.ToDoubleFunction<T>	orReturn(double value)	Returns a ToDoubleFunction returning the given value if this function throws an exception.
default java.util.function.ToDoubleFunction<T>	orReturn(double value, java.util.function.Consumer<java.lang.Exception> exceptionConsumer)	Returns a ToDoubleFunction returning the given value if this function throws an exception.
default ThrowingToDoubleFunction<T>	orThrow(java.lang.Class<? extends java.lang.RuntimeException> exceptionClass)	Returns a ThrowingToDoubleFunction throwing an exception of the given type if this function throws an exception.
default ThrowingToDoubleFunction<T>	orThrow(java.lang.Class<? extends java.lang.RuntimeException> exceptionClass, java.lang.String message)	Returns a ThrowingToDoubleFunction throwing an exception of the given type if this function throws an exception.
default ThrowingToDoubleFunction<T>	orTryWith(ThrowingToDoubleFunction<? super T> other)	Returns a ThrowingToDoubleFunction applying the given function to the argument if this function throws an exception.
default ThrowingToDoubleFunction<T>	orTryWith(ThrowingToDoubleFunction<? super T> other, java.util.function.Consumer<java.lang.Exception> exceptionConsumer)	Returns a ThrowingToDoubleFunction applying the given function to the argument if this function throws an exception.

Method Detail

applyAsDouble

default double applyAsDouble(T argument)

Applies this function to the given argument. Wraps any thrown checked exceptions with UncheckedException.

Specified by:

applyAsDouble in interface java.util.function.ToDoubleFunction<T>

Since:

1.0

applyAsDoubleThrowing

double applyAsDoubleThrowing(T argument)
                      throws java.lang.Exception

Applies this function to the given argument.

Throws:

java.lang.Exception

Since:

1.0

fallbackTo

default java.util.function.ToDoubleFunction<T> fallbackTo(java.util.function.ToDoubleFunction<T> fallback)

Returns a ToDoubleFunction applying the given function to the argument if this function throws an exception.

Throws:

java.lang.IllegalArgumentException - if fallback is null

Since:

1.0

fallbackTo

default java.util.function.ToDoubleFunction<T> fallbackTo(java.util.function.ToDoubleFunction<T> fallback,
                                                          java.util.function.Consumer<java.lang.Exception> exceptionConsumer)

Returns a ToDoubleFunction applying the given function to the argument if this function throws an exception.

Throws:

java.lang.IllegalArgumentException - if fallback is null

Since:

1.0

orReturn

default java.util.function.ToDoubleFunction<T> orReturn(double value)

Returns a ToDoubleFunction returning the given value if this function throws an exception.

Since:

1.0

orReturn

default java.util.function.ToDoubleFunction<T> orReturn(double value,
                                                        java.util.function.Consumer<java.lang.Exception> exceptionConsumer)

Returns a ToDoubleFunction returning the given value if this function throws an exception.

Since:

1.0

orThrow

default ThrowingToDoubleFunction<T> orThrow(java.lang.Class<? extends java.lang.RuntimeException> exceptionClass)

Returns a ThrowingToDoubleFunction throwing an exception of the given type if this function throws an exception. The original exception thrown by this function is the cause of the thrown exception.

The exception class must have a constructor accepting a single Throwable as an argument.

Throws:

java.lang.IllegalArgumentException - if exceptionClass is null

Since:

1.0

orThrow

default ThrowingToDoubleFunction<T> orThrow(java.lang.Class<? extends java.lang.RuntimeException> exceptionClass,
                                            java.lang.String message)

Returns a ThrowingToDoubleFunction throwing an exception of the given type if this function throws an exception. The original exception thrown by this function is the cause of the thrown exception.

The exception class must have a constructor accepting String and Throwable as arguments.

Throws:

java.lang.IllegalArgumentException - if exceptionClass is null

Since:

1.0

orTryWith

default ThrowingToDoubleFunction<T> orTryWith(ThrowingToDoubleFunction<? super T> other)

Returns a ThrowingToDoubleFunction applying the given function to the argument if this function throws an exception.

Throws:

java.lang.IllegalArgumentException - if other is null

Since:

1.0

orTryWith

default ThrowingToDoubleFunction<T> orTryWith(ThrowingToDoubleFunction<? super T> other,
                                              java.util.function.Consumer<java.lang.Exception> exceptionConsumer)

Returns a ThrowingToDoubleFunction applying the given function to the argument if this function throws an exception.

Throws:

java.lang.IllegalArgumentException - if other is null

Since:

1.0