Package ch.powerunit.extensions.exceptions

Interface SupplierWithException<T,E extends Exception>

Type Parameters:

T - the type of results supplied by this supplier

E - the type of the potential exception of the operation

All Superinterfaces:

ExceptionHandlerSupport<Supplier<T>,Supplier<Optional<T>>,SupplierWithException<T,E>>, ObjectReturnExceptionHandlerSupport<Supplier<T>,Supplier<Optional<T>>,Supplier<CompletionStage<T>>,T,SupplierWithException<T,E>>

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 SupplierWithException<T,E extends Exception>
extends ObjectReturnExceptionHandlerSupport<Supplier<T>,Supplier<Optional<T>>,Supplier<CompletionStage<T>>,T,SupplierWithException<T,E>>

Represents a supplier of results that may thrown exception.

There is no requirement that a new or distinct result be returned each time the supplier is invoked.

General contract

• T get() throws E - The functional method.
• uncheck - Return a Supplier<T>
• lift - Return a Supplier<Optional<T>>
• ignore - Return a Supplier<T>

See Also:

Supplier

Method Summary

Modifier and Type	Method	Description
default <T1> FunctionWithException<T1,T,E>	asFunction()	Converts a SupplierWithException to a FunctionWithException .
static <T,R,E extends Exception> FunctionWithException<T,R,E>	asFunction(SupplierWithException<R,E> supplier)	Converts a SupplierWithException to a FunctionWithException.
static <T,E extends Exception> SupplierWithException<T,E>	failing(Supplier<E> exceptionBuilder)	Returns a supplier that always throw exception.
T	get()	Gets a result.
default Supplier<T>	ignore()	Converts this SupplierWithException to a lifted Supplier returning null (or the value redefined by the method ObjectReturnExceptionHandlerSupport.defaultValue()) in case of exception.
static <T,E extends Exception> Supplier<T>	ignored(SupplierWithException<T,E> supplier)	Converts a SupplierWithException to a lifted Supplier returning null in case of exception.
static <T,E extends Exception> Supplier<T>	ignored(SupplierWithException<T,E> supplier, T defaultValue)	Converts a SupplierWithException to a lifted Supplier returning a default value in case of exception.
default Supplier<Optional<T>>	lift()	Converts this SupplierWithException to a lifted Supplier using Optional as return value.
static <T,E extends Exception> Supplier<Optional<T>>	lifted(SupplierWithException<T,E> supplier)	Converts a SupplierWithException to a lifted Supplier using Optional as return value.
default Supplier<CompletionStage<T>>	stage()	Convert this SupplierWithException to a lifted Supplier return CompletionStage as return value.
static <T,E extends Exception> Supplier<CompletionStage<T>>	staged(SupplierWithException<T,E> supplier)	Convert this SupplierWithException to a lifted Supplier return CompletionStage as return value.
default Supplier<T>	uncheck()	Converts this SupplierWithException to a Supplier that wraps exception to RuntimeException.
static <T,E extends Exception> Supplier<T>	unchecked(SupplierWithException<T,E> supplier)	Converts a SupplierWithException to a Supplier that wraps exception to RuntimeException.
static <T,E extends Exception> Supplier<T>	unchecked(SupplierWithException<T,E> supplier, Function<Exception,RuntimeException> exceptionMapper)	Converts a SupplierWithException to a Supplier that wraps exception to RuntimeException by using the provided mapping function.

Methods inherited from interface ch.powerunit.extensions.exceptions.ExceptionHandlerSupport

documented, exceptionMapper

Methods inherited from interface ch.powerunit.extensions.exceptions.ObjectReturnExceptionHandlerSupport

defaultValue, notThrowingHandler, throwingHandler

Method Detail

get

T get()
throws E extends Exception

Gets a result.

Returns:

the result.

Throws:

E - any exception

E extends Exception

See Also:

Supplier.get()

uncheck

default Supplier<T> uncheck()

Converts this SupplierWithException to a Supplier that wraps exception to RuntimeException.

Specified by:

uncheck in interface ExceptionHandlerSupport<Supplier<T>,Supplier<Optional<T>>,SupplierWithException<T,E extends Exception>>

Specified by:

uncheck in interface ObjectReturnExceptionHandlerSupport<Supplier<T>,Supplier<Optional<T>>,Supplier<CompletionStage<T>>,T,SupplierWithException<T,E extends Exception>>

Returns:

the unchecked supplier

See Also:

unchecked(SupplierWithException), unchecked(SupplierWithException, Function)

lift

default Supplier<Optional<T>> lift()

Converts this SupplierWithException to a lifted Supplier using Optional as return value.

Specified by:

lift in interface ExceptionHandlerSupport<Supplier<T>,Supplier<Optional<T>>,SupplierWithException<T,E extends Exception>>

Specified by:

lift in interface ObjectReturnExceptionHandlerSupport<Supplier<T>,Supplier<Optional<T>>,Supplier<CompletionStage<T>>,T,SupplierWithException<T,E extends Exception>>

Returns:

the lifted supplier

See Also:

lifted(SupplierWithException)

ignore

default Supplier<T> ignore()

Converts this SupplierWithException to a lifted Supplier returning null (or the value redefined by the method ObjectReturnExceptionHandlerSupport.defaultValue()) in case of exception.

Specified by:

ignore in interface ExceptionHandlerSupport<Supplier<T>,Supplier<Optional<T>>,SupplierWithException<T,E extends Exception>>

Specified by:

ignore in interface ObjectReturnExceptionHandlerSupport<Supplier<T>,Supplier<Optional<T>>,Supplier<CompletionStage<T>>,T,SupplierWithException<T,E extends Exception>>

Returns:

the supplier that ignore error

See Also:

ignored(SupplierWithException)

stage

default Supplier<CompletionStage<T>> stage()

Convert this SupplierWithException to a lifted Supplier return CompletionStage as return value.

Specified by:

stage in interface ObjectReturnExceptionHandlerSupport<Supplier<T>,Supplier<Optional<T>>,Supplier<CompletionStage<T>>,T,SupplierWithException<T,E extends Exception>>

Returns:

the lifted supplier

See Also:

staged(SupplierWithException)

failing

static <T,E extends Exception> SupplierWithException<T,E> failing(Supplier<E> exceptionBuilder)

Returns a supplier that always throw exception.

Type Parameters:

T - the type of the return object to the operation

E - the type of the exception

Parameters:

exceptionBuilder - the supplier to create the exception

Returns:

an operation that always throw exception

unchecked

static <T,E extends Exception> Supplier<T> unchecked(SupplierWithException<T,E> supplier)

Converts a SupplierWithException to a Supplier that wraps exception to RuntimeException.

Type Parameters:

T - the type of the output object to the operation

E - the type of the potential exception

Parameters:

supplier - to be unchecked

Returns:

the unchecked exception

Throws:

NullPointerException - if supplier is null

See Also:

uncheck(), unchecked(SupplierWithException, Function)

unchecked

static <T,E extends Exception> Supplier<T> unchecked(SupplierWithException<T,E> supplier,
                                                     Function<Exception,RuntimeException> exceptionMapper)

Converts a SupplierWithException to a Supplier that wraps exception to RuntimeException by using the provided mapping function.

Type Parameters:

T - the type of the output object to the operation

E - the type of the potential exception

Parameters:

supplier - the be unchecked

exceptionMapper - a function to convert the exception to the runtime exception.

Returns:

the unchecked exception

Throws:

NullPointerException - if supplier or exceptionMapper is null

See Also:

uncheck(), unchecked(SupplierWithException)

lifted

static <T,E extends Exception> Supplier<Optional<T>> lifted(SupplierWithException<T,E> supplier)

Converts a SupplierWithException to a lifted Supplier using Optional as return value.

Type Parameters:

T - the type of the output object to the function

E - the type of the potential exception

Parameters:

supplier - to be lifted

Returns:

the lifted function

Throws:

NullPointerException - if supplier is null

See Also:

lift()

ignored

static <T,E extends Exception> Supplier<T> ignored(SupplierWithException<T,E> supplier)

Converts a SupplierWithException to a lifted Supplier returning null in case of exception.

Type Parameters:

T - the type of the output object to the function

E - the type of the potential exception

Parameters:

supplier - to be lifted

Returns:

the lifted supplier

Throws:

NullPointerException - if supplier is null

See Also:

ignore()

ignored

static <T,E extends Exception> Supplier<T> ignored(SupplierWithException<T,E> supplier,
                                                   T defaultValue)

Converts a SupplierWithException to a lifted Supplier returning a default value in case of exception.

Type Parameters:

T - the type of the output object to the function

E - the type of the potential exception

Parameters:

supplier - to be lifted

defaultValue - the default value in case of exception

Returns:

the lifted supplier

Throws:

NullPointerException - if supplier is null

Since:

3.0.0

See Also:

ignore(), ignored(SupplierWithException)

staged

static <T,E extends Exception> Supplier<CompletionStage<T>> staged(SupplierWithException<T,E> supplier)

Convert this SupplierWithException to a lifted Supplier return CompletionStage as return value.

Type Parameters:

T - the type of the output object to the function

E - the type of the potential exception

Parameters:

supplier - to be lifted

Returns:

the lifted supplier

Throws:

NullPointerException - if supplier is null

See Also:

stage()

asFunction

static <T,R,E extends Exception> FunctionWithException<T,R,E> asFunction(SupplierWithException<R,E> supplier)

Converts a SupplierWithException to a FunctionWithException.

Type Parameters:

T - the input type of the function

R - the result type of the function

E - the type of the potential exception

Parameters:

supplier - the supplier to be converted

Returns:

the function

Throws:

NullPointerException - if consumer is null

Since:

1.2.0

asFunction

default <T1> FunctionWithException<T1,T,E> asFunction()

Converts a SupplierWithException to a FunctionWithException .

Type Parameters:

T1 - the input parameter of the function

Returns:

the function

Since:

1.2.0