Package org.sellcom.core.util.function

Interface ThrowingFunction<T,R>

All Superinterfaces:

java.util.function.Function<T,R>

All Known Subinterfaces:

ThrowingUnaryOperator<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 ThrowingFunction<T,R>
extends java.util.function.Function<T,R>

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

Example

 ThrowingFunction<String, Integer> parse = Integer::parseInt;
 Function<String, Optional<Integer>> safeParse = parse.fallbackTo(string -> null)
         .andThen(Optional::ofNullable);
 

Since:

1.0

Method Summary

Modifier and Type	Method	Description
default <V> ThrowingFunction<T,V>	andThen(ThrowingFunction<? super R,? extends V> after)	Returns a composed ThrowingFunction that first applies this function to the argument, and then applies the after function to the result.
default R	apply(T argument)	Applies this function to the given argument.
R	applyThrowing(T argument)	Applies this function to the given argument.
default <V> ThrowingFunction<V,R>	compose(ThrowingFunction<? super V,? extends T> before)	Returns a composed ThrowingFunction that first applies the before function to the argument, and then applies this function to the result.
default java.util.function.Function<T,R>	fallbackTo(java.util.function.Function<T,R> fallback)	Returns a Function applying the given function to the argument if this function throws an exception.
default java.util.function.Function<T,R>	fallbackTo(java.util.function.Function<T,R> fallback, java.util.function.Consumer<java.lang.Exception> exceptionConsumer)	Returns a Function applying the given function to the argument if this function throws an exception.
default java.util.function.Function<T,R>	orReturn(R value)	Returns a Function returning the given value if this function throws an exception.
default java.util.function.Function<T,R>	orReturn(R value, java.util.function.Consumer<java.lang.Exception> exceptionConsumer)	Returns a Function returning the given value if this function throws an exception.
default ThrowingFunction<T,R>	orThrow(java.lang.Class<? extends java.lang.RuntimeException> exceptionClass)	Returns a ThrowingFunction throwing an exception of the given type if this function throws an exception.
default ThrowingFunction<T,R>	orThrow(java.lang.Class<? extends java.lang.RuntimeException> exceptionClass, java.lang.String message)	Returns a ThrowingFunction throwing an exception of the given type if this function throws an exception.
default ThrowingFunction<T,R>	orTryWith(ThrowingFunction<? super T,? extends R> other)	Returns a ThrowingFunction applying the given function to the argument if this function throws an exception.
default ThrowingFunction<T,R>	orTryWith(ThrowingFunction<? super T,? extends R> other, java.util.function.Consumer<java.lang.Exception> exceptionConsumer)	Returns a ThrowingFunction applying the given function to the argument if this function throws an exception.

Methods inherited from interface java.util.function.Function

andThen, compose

Method Detail

andThen

default <V> ThrowingFunction<T,V> andThen(ThrowingFunction<? super R,? extends V> after)

Returns a composed ThrowingFunction that first applies this function to the argument, and then applies the after function to the result.

Throws:

java.lang.IllegalArgumentException - if after is null

Since:

1.0

apply

default R apply(T argument)

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

Specified by:

apply in interface java.util.function.Function<T,R>

Since:

1.0

applyThrowing

R applyThrowing(T argument)
         throws java.lang.Exception

Applies this function to the given argument.

Throws:

java.lang.Exception

Since:

1.0

compose

default <V> ThrowingFunction<V,R> compose(ThrowingFunction<? super V,? extends T> before)

Returns a composed ThrowingFunction that first applies the before function to the argument, and then applies this function to the result.

Throws:

java.lang.IllegalArgumentException - if before is null

Since:

1.0

fallbackTo

default java.util.function.Function<T,R> fallbackTo(java.util.function.Function<T,R> fallback)

Returns a Function 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.Function<T,R> fallbackTo(java.util.function.Function<T,R> fallback,
                                                    java.util.function.Consumer<java.lang.Exception> exceptionConsumer)

Returns a Function 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.Function<T,R> orReturn(R value)

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

Since:

1.0

orReturn

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

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

Since:

1.0

orThrow

default ThrowingFunction<T,R> orThrow(java.lang.Class<? extends java.lang.RuntimeException> exceptionClass)

Returns a ThrowingFunction 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 ThrowingFunction<T,R> orThrow(java.lang.Class<? extends java.lang.RuntimeException> exceptionClass,
                                      java.lang.String message)

Returns a ThrowingFunction 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 ThrowingFunction<T,R> orTryWith(ThrowingFunction<? super T,? extends R> other)

Returns a ThrowingFunction 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 ThrowingFunction<T,R> orTryWith(ThrowingFunction<? super T,? extends R> other,
                                        java.util.function.Consumer<java.lang.Exception> exceptionConsumer)

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

Throws:

java.lang.IllegalArgumentException - if other is null

Since:

1.0