Record Class Result.Err<Value,Error>

java.lang.Object

java.lang.Record

codes.domix.fun.Result.Err<Value,Error>

Type Parameters:

Value - the type of the value contained in a successful result, unused here

Error - the type of the error contained in the erroneous result

Record Components:

error - the non-null error value that represents the erroneous result; passing null throws NullPointerException

All Implemented Interfaces:

Result<Value,Error>

Enclosing interface:

Result<Value,Error>

public static record Result.Err<Value,Error>(Error error)
extends Record
implements Result<Value,Error>

Represents an erroneous result containing an error of type Error.

This record implements the Result interface and represents the "Err" variant of a result. It encapsulates an error value that indicates a failed computation or action.

Nested Class Summary

Nested classes/interfaces inherited from interface codes.domix.fun.Result

Result.Err<Value,Error>, Result.Ok<Value,Error>

Constructor Summary

Constructors

Constructor	Description
Err(Error error)	Compact canonical constructor — validates that error is non-null.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Error	error()	Returns the value of the error record component.
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 codes.domix.fun.Result

filter, filter, flatMap, flatMapError, fold, get, getError, getOrElse, getOrElseGet, getOrElseGetWithError, getOrNull, getOrThrow, isError, isOk, map, mapError, match, or, peek, peekError, recover, recoverWith, swap, toOption, toTry

Constructor Details

Err

public Err(Error error)

Compact canonical constructor — validates that error is non-null.

Throws:

NullPointerException - if error is null

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.

error

public Error error()

Returns the value of the error record component.

Returns:

the value of the error record component