Module info.jab.util

Package info.jab.util.result

Record Class Success<T>

java.lang.Object

java.lang.Record

info.jab.util.result.Success<T>

Type Parameters:

T - the type of the value returned in a successful computation

Record Components:

value - the value resulting from a successful computation

All Implemented Interfaces:

Result<T>

public record Success<T>(T value)
extends Record
implements Result<T>

Record representing a successful Result in the Result.

This record encapsulates the successful state of a computation within the Result, holding the value resulting from a successful computation.

Nested Class Summary

Nested classes/interfaces inherited from interface info.jab.util.result.Result

Result.CheckedSupplier<T>

Constructor Summary

Constructors

Constructor	Description
Success(T value)	Creates an instance of a Success record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
<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.
final int	hashCode()	Returns a hash code value for this object.
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.
final String	toString()	Returns a string representation of this record class.
T	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Success

public Success(T value)

Creates an instance of a Success record class.

Parameters:

value - the value for the value record component

Method Details

isSuccess

public boolean isSuccess()

Description copied from interface: Result

Checks if the Result is successful.

Specified by:

isSuccess in interface Result<T>

Returns:

true if successful, false otherwise

isFailure

public boolean isFailure()

Description copied from interface: Result

Checks if the Result is a failure.

Specified by:

isFailure in interface Result<T>

Returns:

true if a failure, false otherwise

ifSuccess

public void ifSuccess(Consumer<T> consumer)

Description copied from interface: Result

Performs the given action if the Result is successful.

Specified by:

ifSuccess in interface Result<T>

Parameters:

consumer - the action to be performed

ifFailure

public void ifFailure(Consumer<Throwable> consumer)

Description copied from interface: Result

Performs the given action if the Result is a failure.

Specified by:

ifFailure in interface Result<T>

Parameters:

consumer - the action to be performed

getValue

public Optional<T> getValue()

Description copied from interface: Result

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

Specified by:

getValue in interface Result<T>

Returns:

an Optional with the value or empty if failure

getException

public Optional<Throwable> getException()

Description copied from interface: Result

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

Specified by:

getException in interface Result<T>

Returns:

an Optional with the exception or empty if success

getOrElse

public T getOrElse(Supplier<? extends T> other)

Description copied from interface: Result

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

Specified by:

getOrElse in interface Result<T>

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

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

Description copied from interface: Result

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

Specified by:

map in interface Result<T>

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

flatMap

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

Description copied from interface: Result

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

Specified by:

flatMap in interface Result<T>

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

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

Description copied from interface: Result

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

Specified by:

recover in interface Result<T>

Parameters:

mapper - the function to apply to the exception

Returns:

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

recoverCatching

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

Description copied from interface: Result

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.

Specified by:

recoverCatching in interface Result<T>

Parameters:

mapper - the function to apply to the exception

Returns:

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

fold

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

Description copied from interface: Result

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.

Specified by:

fold in interface Result<T>

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

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

value

public T value()

Returns the value of the value record component.

Returns:

the value of the value record component