Module info.jab.util

Package info.jab.util.result

Interface Result<T>

Type Parameters:

T - the type of the value

All Known Implementing Classes:

Failure, Success

public sealed interface Result<T>
permits Success<T>, Failure<T>

A sealed interface representing a computation that may either result in a value (success) or an exception (failure).

Author:

Juan Antonio Breña Moral, ChatGPT-40

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Result.CheckedSupplier<T>	A functional interface representing a supplier that may throw an exception.

Method Summary

Modifier and Type	Method	Description
static <T> Result<T>	failure(Throwable exception)	Creates a failed Result with the given exception.
<U> Result<U>	flatMap(Function<? super T,Result<U>> mapper)	Applies the given function to the value if the Result is successful and returns a new Result.
<U> U	fold(U initialValue, Function<? super T,U> folder)	Reduces the Result to a single value by applying a function to the successful value or a default value if the result is a failure.
Optional<Throwable>	getException()	Returns the exception if present, otherwise returns an empty Optional.
T	getOrElse(Supplier<? extends T> other)	Returns the value if the Result is successful, otherwise returns the result of the specified Supplier.
Optional<T>	getValue()	Returns the value if present, otherwise returns an empty Optional.
void	ifFailure(Consumer<Throwable> consumer)	Performs the given action if the Result is a failure.
void	ifSuccess(Consumer<T> consumer)	Performs the given action if the Result is successful.
boolean	isFailure()	Checks if the Result is a failure.
boolean	isSuccess()	Checks if the Result is successful.
<U> Result<U>	map(Function<? super T,? extends U> mapper)	Applies the given function to the value if the Result is successful and returns a new Result.
Result<T>	recover(Function<? super Throwable,? extends T> mapper)	Applies the given function to the exception if the Result is a failure and returns a new Result with the mapped value.
Result<T>	recoverCatching(Function<? super Throwable,Result<T>> mapper)	Applies the given function to the exception if the Result is a failure and returns a new Result.
static <T> Result<T>	runCatching(Result.CheckedSupplier<T> supplier)	Executes the given supplier and returns a Result.
static <T> Result<T>	success(T value)	Creates a successful Result with the given value.

Method Details

failure

static <T> Result<T> failure(Throwable exception)

Creates a failed Result with the given exception.

Type Parameters:

T - the type of the value

Parameters:

exception - the exception

Returns:

a failed Result

success

static <T> Result<T> success(T value)

Creates a successful Result with the given value.

Type Parameters:

T - the type of the value

Parameters:

value - the value

Returns:

a successful Result

isSuccess

boolean isSuccess()

Checks if the Result is successful.

Returns:

true if successful, false otherwise

isFailure

boolean isFailure()

Checks if the Result is a failure.

Returns:

true if a failure, false otherwise

ifSuccess

void ifSuccess(Consumer<T> consumer)

Performs the given action if the Result is successful.

Parameters:

consumer - the action to be performed

ifFailure

void ifFailure(Consumer<Throwable> consumer)

Performs the given action if the Result is a failure.

Parameters:

consumer - the action to be performed

getValue

Optional<T> getValue()

Returns the value if present, otherwise returns an empty Optional.

Returns:

an Optional with the value or empty if failure

getException

Optional<Throwable> getException()

Returns the exception if present, otherwise returns an empty Optional.

Returns:

an Optional with the exception or empty if success

getOrElse

T getOrElse(Supplier<? extends T> other)

Returns the value if the Result is successful, otherwise returns the result of the specified Supplier.

Parameters:

other - a Supplier whose result is returned if the Result is a failure

Returns:

the value if the Result is successful, otherwise the result of the Supplier

map

<U> Result<U> map(Function<? super T,? extends U> mapper)

Applies the given function to the value if the Result is successful and returns a new Result.

Type Parameters:

U - the type of the value of the new Result

Parameters:

mapper - the function to apply to the value

Returns:

a new Result with the mapped value if successful, otherwise the original failure

fold

<U> U fold(U initialValue,
 Function<? super T,U> folder)

Reduces the Result to a single value by applying a function to the successful value or a default value if the result is a failure.

Type Parameters:

U - the type of the folded value

Parameters:

initialValue - the initial value to use if the result is a failure

folder - the function to apply to the successful value or the initial value

Returns:

the folded value

flatMap

<U> Result<U> flatMap(Function<? super T,Result<U>> mapper)

Applies the given function to the value if the Result is successful and returns a new Result. The function should return a new Result.

Type Parameters:

U - the type of the value of the new Result

Parameters:

mapper - the function to apply to the value

Returns:

the Result returned by the mapper if successful, otherwise the original failure

recover

Result<T> recover(Function<? super Throwable,? extends T> mapper)

Applies the given function to the exception if the Result is a failure and returns a new Result with the mapped value.

Parameters:

mapper - the function to apply to the exception

Returns:

a new Result with the mapped value if failure, otherwise the original success

recoverCatching

Result<T> recoverCatching(Function<? super Throwable,Result<T>> mapper)

Applies the given function to the exception if the Result is a failure and returns a new Result. The function should return a new Result.

Parameters:

mapper - the function to apply to the exception

Returns:

the Result returned by the mapper if failure, otherwise the original success

runCatching

static <T> Result<T> runCatching(Result.CheckedSupplier<T> supplier)

Executes the given supplier and returns a Result. If the supplier throws an exception, it returns a failed Result with the thrown exception.

Type Parameters:

T - the type of the value

Parameters:

supplier - the supplier to execute

Returns:

a successful Result if the supplier succeeds, otherwise a failed Result