Package tech.catheu.jnotebook

Record Class ExecutionStatus

java.lang.Object

java.lang.Record

tech.catheu.jnotebook.ExecutionStatus

public record ExecutionStatus(@NonNull ExecutionStatus.Status status, @Nullable String failureMessage, @Nullable Exception failureException)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ExecutionStatus.Status

Constructor Summary

Constructors

Constructor	Description
ExecutionStatus(@NonNull ExecutionStatus.Status status, @Nullable String failureMessage, @Nullable Exception failureException)	Creates an instance of a ExecutionStatus record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static ExecutionStatus	failure(@NonNull String failureMessage, @Nullable Exception failureException)
@Nullable Exception	failureException()	Returns the value of the failureException record component.
@Nullable String	failureMessage()	Returns the value of the failureMessage record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	isOk()
static ExecutionStatus	ok()
@NonNull ExecutionStatus.Status	status()	Returns the value of the status record component.
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

Constructor Details

ExecutionStatus

public ExecutionStatus(@NonNull ExecutionStatus.Status status,
 @Nullable String failureMessage,
 @Nullable Exception failureException)

Creates an instance of a ExecutionStatus record class.

Parameters:

status - the value for the status record component

failureMessage - the value for the failureMessage record component

failureException - the value for the failureException record component

Method Details

isOk

public boolean isOk()

ok

public static ExecutionStatus ok()

failure

public static ExecutionStatus failure(@NonNull String failureMessage,
 @Nullable Exception failureException)

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.

status

public @NonNull ExecutionStatus.Status status()

Returns the value of the status record component.

Returns:

the value of the status record component

failureMessage

public @Nullable String failureMessage()

Returns the value of the failureMessage record component.

Returns:

the value of the failureMessage record component

failureException

public @Nullable Exception failureException()

Returns the value of the failureException record component.

Returns:

the value of the failureException record component