org.slieb.throwables

Interface FunctionWithThrowable<T,R,E extends Throwable>

Type Parameters:

T - some generic flag

R - some generic flag

E - The extension

All Superinterfaces:

Function<T,R>

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 FunctionWithThrowable<T,R,E extends Throwable>
extends Function<T,R>

Generated from Function Extends java.util.function.Function to allow for a checked exception.

Method Summary

Modifier and Type	Method and Description
static <T,R,E extends Throwable> Function<T,R>	aFunctionThatUnsafelyThrowsUnchecked(FunctionWithThrowable<T,R,E> functionwiththrowable) Utility method to unwrap lambdas of type Function and withUncheckedThrowable any Exception
default R	apply(T v1) Overridden method of FunctionWithThrowable that will call applyWithThrowable, but catching any exceptions.
R	applyWithThrowable(T v1) Functional method that will throw exceptions.
static <T,R,E extends Throwable> FunctionWithThrowable<T,R,E>	asFunctionWithThrowable(Function<T,R> function) Utility method to convert FunctionWithThrowable
static <T,R,E extends Throwable> FunctionWithThrowable<T,R,E>	castFunctionWithThrowable(FunctionWithThrowable<T,R,E> functionwiththrowable) Utility method to mark lambdas of type FunctionWithThrowable
default FunctionWithThrowable<T,R,E>	onException(BiConsumer<Throwable,Object[]> consumer)
default FunctionWithThrowable<T,R,E>	onException(Consumer<Throwable> consumer)
default Function<T,R>	thatReturnsOnCatch(R defaultReturnValue)
default Function<T,Optional<R>>	thatReturnsOptional()
default Function<T,R>	thatUnsafelyThrowsUnchecked()
default FunctionWithThrowable<T,R,E>	withLogging() Will log WARNING level exceptions on logger if they occur within the interface
default FunctionWithThrowable<T,R,E>	withLogging(org.slf4j.Logger logger) Will log WARNING level exceptions on logger if they occur within the interface
default FunctionWithThrowable<T,R,E>	withLogging(org.slf4j.Logger logger, String message)

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Method Detail

castFunctionWithThrowable

static <T,R,E extends Throwable> FunctionWithThrowable<T,R,E> castFunctionWithThrowable(FunctionWithThrowable<T,R,E> functionwiththrowable)

Utility method to mark lambdas of type FunctionWithThrowable

Type Parameters:

T - Generic that corresponds to the same generic on Function

R - Generic that corresponds to the same generic on Function

E - The type this interface is allowed to throw

Parameters:

functionwiththrowable - The interface instance

Returns:

the cast interface

aFunctionThatUnsafelyThrowsUnchecked

static <T,R,E extends Throwable> Function<T,R> aFunctionThatUnsafelyThrowsUnchecked(FunctionWithThrowable<T,R,E> functionwiththrowable)
                                                                             throws E extends Throwable

Utility method to unwrap lambdas of type Function and withUncheckedThrowable any Exception

Type Parameters:

T - Generic that corresponds to the same generic on Function

R - Generic that corresponds to the same generic on Function

E - The type this interface is allowed to throw

Parameters:

functionwiththrowable - The interface instance

Returns:

the cast interface

Throws:

E - the original Exception from functionwiththrowable

E extends Throwable

asFunctionWithThrowable

static <T,R,E extends Throwable> FunctionWithThrowable<T,R,E> asFunctionWithThrowable(Function<T,R> function)

Utility method to convert FunctionWithThrowable

Type Parameters:

T - Generic that corresponds to the same generic on Function

R - Generic that corresponds to the same generic on Function

E - The type this interface is allowed to throw

Parameters:

function - The interface instance

Returns:

the cast interface

apply

default R apply(T v1)

Overridden method of FunctionWithThrowable that will call applyWithThrowable, but catching any exceptions.

Specified by:

apply in interface Function<T,R>

Parameters:

v1 - parameter to overridden method

Returns:

the value

applyWithThrowable

R applyWithThrowable(T v1)
              throws E extends Throwable

Functional method that will throw exceptions.

Parameters:

v1 - parameter to overridden method

Returns:

the value

Throws:

E - some exception

E extends Throwable

thatReturnsOptional

default Function<T,Optional<R>> thatReturnsOptional()

Returns:

An interface that will wrap the result in an optional, and return an empty optional when an exception occurs.

thatReturnsOnCatch

default Function<T,R> thatReturnsOnCatch(R defaultReturnValue)

Parameters:

defaultReturnValue - A value to return if any throwable is caught.

Returns:

An interface that returns a default value if any exception occurs.

thatUnsafelyThrowsUnchecked

default Function<T,R> thatUnsafelyThrowsUnchecked()
                                           throws E extends Throwable

Returns:

An interface that is only returned if no exception has been thrown.

Throws:

E - if an exception E has been thrown, it is rethrown by this method

E extends Throwable

withLogging

default FunctionWithThrowable<T,R,E> withLogging(org.slf4j.Logger logger,
                                                 String message)

Parameters:

logger - The logger to log exceptions on

message - A message to use for logging exceptions

Returns:

An interface that will log all exceptions to given logger

withLogging

default FunctionWithThrowable<T,R,E> withLogging(org.slf4j.Logger logger)

Will log WARNING level exceptions on logger if they occur within the interface

Parameters:

logger - The logger instance to log exceptions on

Returns:

An interface that will log exceptions on given logger

withLogging

default FunctionWithThrowable<T,R,E> withLogging()

Will log WARNING level exceptions on logger if they occur within the interface

Returns:

An interface that will log exceptions on global logger

onException

default FunctionWithThrowable<T,R,E> onException(Consumer<Throwable> consumer)

Parameters:

consumer - An exception consumer.

Returns:

An interface that will log all exceptions to given logger

onException

default FunctionWithThrowable<T,R,E> onException(BiConsumer<Throwable,Object[]> consumer)

Parameters:

consumer - An exception consumer.

Returns:

An interface that will log all exceptions to given logger