Module io.github.teceli.resiliencia.core

Package io.github.teceli.resiliencia.core.api

Record Class Outcome.Failure<T>

java.lang.Object

java.lang.Record

io.github.teceli.resiliencia.core.api.Outcome.Failure<T>

All Implemented Interfaces:

Outcome<T>

Enclosing interface:

Outcome<T>

public static record Outcome.Failure<T>(Throwable cause)
extends Record
implements Outcome<T>

Operation failed with an exception. cause is always present — a Failure with no cause is not a meaningful outcome.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.teceli.resiliencia.core.api.Outcome

Outcome.Failure<T>, Outcome.Success<T>, Outcome.TimedOut<T>

Constructor Summary

Constructors

Constructor	Description
Failure(Throwable cause)	Creates an instance of a Failure record class.

Method Summary

Modifier and Type	Method	Description
Throwable	cause()	Returns the value of the cause record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.teceli.resiliencia.core.api.Outcome

fold

Constructor Details

Failure

public Failure(Throwable cause)

Creates an instance of a Failure record class.

Parameters:

cause - the value for the cause record component

Method Details

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.

cause

public Throwable cause()

Returns the value of the cause record component.

Returns:

the value of the cause record component