Package ch.powerunit.extensions.exceptions

Interface LongSupplierWithException<E extends Exception>

Type Parameters:

E - the type of the potential exception of the operation

All Superinterfaces:

ExceptionHandlerSupport<LongSupplier,LongSupplier,LongSupplierWithException<E>>, PrimitiveReturnExceptionHandlerSupport<LongSupplier,LongSupplierWithException<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 LongSupplierWithException<E extends Exception>
extends PrimitiveReturnExceptionHandlerSupport<LongSupplier,LongSupplierWithException<E>>

Represents a supplier of long-valued results and may throw exception. This is the long-producing primitive specialization of SupplierWithException.

General contract

• long getAsLong() throws E - The functional method.
• uncheck - Return a LongSupplier
• lift - Return a LongSupplier
• ignore - Return a LongSupplier

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

See Also:

SupplierWithException

Method Summary

Modifier and Type	Method	Description
default long	defaultValue()	Defines the default value returned by the ignore and ignored method.
static <E extends Exception> LongSupplierWithException<E>	failing(Supplier<E> exceptionBuilder)	Returns a supplier that always throw exception.
long	getAsLong()	Gets a result.
default LongSupplier	ignore()	Converts this LongSupplierWithException to a lifted LongSupplier returning 0 in case of exception.
static <E extends Exception> LongSupplier	ignored(LongSupplierWithException<E> supplier)	Converts a LongSupplierWithException to a lifted LongSupplier returning 0 in case of exception.
static <E extends Exception> LongSupplier	ignored(LongSupplierWithException<E> supplier, long defaultValue)	Converts a LongSupplierWithException to a lifted LongSupplier returning a default value in case of exception.
static <E extends Exception> LongSupplier	lifted(LongSupplierWithException<E> supplier)	Converts a LongSupplierWithException to a lifted LongSupplier returning 0 in case of exception.
default LongSupplier	uncheck()	Converts this LongSupplierWithException to a LongSupplier that wraps exception to RuntimeException.
static <E extends Exception> LongSupplier	unchecked(LongSupplierWithException<E> supplier)	Converts a LongSupplierWithException to a LongSupplier that wraps exception to RuntimeException.
static <E extends Exception> LongSupplier	unchecked(LongSupplierWithException<E> supplier, Function<Exception,RuntimeException> exceptionMapper)	Converts a LongSupplierWithException to a LongSupplier that wraps exception to RuntimeException by using the provided mapping function.
default LongSupplier	uncheckOrIgnore(boolean uncheck)	Used internally to implements the ignore or uncheck operation.

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

documented, exceptionMapper

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

lift

Method Detail

getAsLong

long getAsLong()
        throws E extends Exception

Gets a result.

Returns:

a result

Throws:

E - any exception

E extends Exception

See Also:

LongSupplier.getAsLong()

uncheckOrIgnore

default LongSupplier uncheckOrIgnore(boolean uncheck)

Description copied from interface: PrimitiveReturnExceptionHandlerSupport

Used internally to implements the ignore or uncheck operation.

Specified by:

uncheckOrIgnore in interface PrimitiveReturnExceptionHandlerSupport<LongSupplier,LongSupplierWithException<E extends Exception>>

Parameters:

uncheck - create unchecked version of the function when true, else ignored version.

Returns:

the function

uncheck

default LongSupplier uncheck()

Converts this LongSupplierWithException to a LongSupplier that wraps exception to RuntimeException.

Specified by:

uncheck in interface ExceptionHandlerSupport<LongSupplier,LongSupplier,LongSupplierWithException<E extends Exception>>

Specified by:

uncheck in interface PrimitiveReturnExceptionHandlerSupport<LongSupplier,LongSupplierWithException<E extends Exception>>

Returns:

the unchecked supplier

See Also:

unchecked(LongSupplierWithException), unchecked(LongSupplierWithException, Function)

ignore

default LongSupplier ignore()

Converts this LongSupplierWithException to a lifted LongSupplier returning 0 in case of exception.

Specified by:

ignore in interface ExceptionHandlerSupport<LongSupplier,LongSupplier,LongSupplierWithException<E extends Exception>>

Specified by:

ignore in interface PrimitiveReturnExceptionHandlerSupport<LongSupplier,LongSupplierWithException<E extends Exception>>

Returns:

the supplier that ignore error

See Also:

ignored(LongSupplierWithException)

failing

static <E extends Exception> LongSupplierWithException<E> failing(Supplier<E> exceptionBuilder)

Returns a supplier that always throw exception.

Type Parameters:

E - the type of the exception

Parameters:

exceptionBuilder - the supplier to create the exception

Returns:

an operation that always throw exception

unchecked

static <E extends Exception> LongSupplier unchecked(LongSupplierWithException<E> supplier)

Converts a LongSupplierWithException to a LongSupplier that wraps exception to RuntimeException.

Type Parameters:

E - the type of the potential exception

Parameters:

supplier - to be unchecked

Returns:

the unchecked supplier

Throws:

NullPointerException - if supplier is null

See Also:

uncheck(), unchecked(LongSupplierWithException, Function)

unchecked

static <E extends Exception> LongSupplier unchecked(LongSupplierWithException<E> supplier,
                                                    Function<Exception,RuntimeException> exceptionMapper)

Converts a LongSupplierWithException to a LongSupplier that wraps exception to RuntimeException by using the provided mapping function.

Type Parameters:

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 supplier

Throws:

NullPointerException - if supplier or exceptionMapper is null

See Also:

uncheck(), unchecked(LongSupplierWithException)

lifted

static <E extends Exception> LongSupplier lifted(LongSupplierWithException<E> supplier)

Converts a LongSupplierWithException to a lifted LongSupplier returning 0 in case of exception.

Type Parameters:

E - the type of the potential exception

Parameters:

supplier - to be lifted

Returns:

the lifted supplier

Throws:

NullPointerException - if supplier is null

See Also:

PrimitiveReturnExceptionHandlerSupport.lift()

ignored

static <E extends Exception> LongSupplier ignored(LongSupplierWithException<E> supplier)

Converts a LongSupplierWithException to a lifted LongSupplier returning 0 in case of exception.

Type Parameters:

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 <E extends Exception> LongSupplier ignored(LongSupplierWithException<E> supplier,
                                                  long defaultValue)

Converts a LongSupplierWithException to a lifted LongSupplier returning a default value in case of exception.

Type Parameters:

E - the type of the potential exception

Parameters:

supplier - to be lifted

defaultValue - value in case of exception

Returns:

the lifted supplier

Throws:

NullPointerException - if supplier is null

Since:

3.0.0

See Also:

ignore(), ignored(LongSupplierWithException)

defaultValue

default long defaultValue()

Defines the default value returned by the ignore and ignored method.

Returns:

the default value for the ignore/ignored method.

Since:

3.0.0