Record Class Result.Ok<Value,Error>

java.lang.Object

java.lang.Record

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

Type Parameters:

Value - the type of the value contained in the successful result

Error - the type of the error contained in the erroneous result, unused here

Record Components:

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

All Implemented Interfaces:

Result<Value,Error>

Enclosing interface:

Result<Value,Error>

public static record Result.Ok<Value,Error>(Value value)
extends Record
implements Result<Value,Error>

Represents a successful result containing a value of type Value.

This record implements the Result interface and indicates the "Ok" variant of a result. It encapsulates a non-null value that represents a successful computation or action. To model a successful result with no meaningful value use Result<Void, Error>; for an optional value use Result<Option<Value>, Error>.

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
Ok(Value value)	Compact canonical constructor — validates that value 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.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
Value	value()	Returns the value of the value record component.

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

Ok

public Ok(Value value)

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

Throws:

NullPointerException - if value 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.

value

public Value value()

Returns the value of the value record component.

Returns:

the value of the value record component