de.larssh.utils.function

Interface ThrowingFunction<T,R>

Type Parameters:

T - the type of the input to the function

R - the type of the result of the function

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 ThrowingFunction<T,R>
extends Function<T,R>

Represents a function that accepts one argument and produces a result.

ThrowingFunctions can throw any kind of Exception. When used as Function exceptions are hidden from compiler.

This is a functional interface whose functional method is applyThrowing(Object).

Method Summary

Modifier and Type	Method and Description
default R	apply(T value) Applies this function to the given argument, allow throwing any kind of Exception.
R	applyThrowing(T value) Applies this function to the given argument, allow throwing any kind of Exception.
static <T,R> Function<T,R>	throwing(ThrowingFunction<T,R> function) Short-hand method to cast any ThrowingFunction as Function.

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Method Detail

throwing

static <T,R> Function<T,R> throwing(ThrowingFunction<T,R> function)

Short-hand method to cast any ThrowingFunction as Function.

Type Parameters:

T - the type of the input to the function

R - the type of the result of the function

Parameters:

function - throwing function

Returns:

hidden throwing function

apply

@Nullable
default R apply(@Nullable
                          T value)

Applies this function to the given argument, allow throwing any kind of Exception.

As this hides exceptions from the compiler, the calling method should either:

• have a throws statement for the hidden exceptions
• handle hidden exceptions using catch
• or at least document the hidden exceptions in JavaDoc using @throws.

Specified by:

apply in interface Function<T,R>

Parameters:

value - the function argument

Returns:

the function result

Throws:

SneakyException - hidden exceptions

applyThrowing

@Nullable
R applyThrowing(@Nullable
                          T value)
                   throws Exception

Applies this function to the given argument, allow throwing any kind of Exception.

Parameters:

value - the function argument

Returns:

the function result

Throws:

Exception - any kind of exception