Record Class Option.Some<Value>

java.lang.Object

java.lang.Record

codes.domix.fun.Option.Some<Value>

Type Parameters:

Value - the type of the non-null value encapsulated by this instance

Record Components:

value - the non-null value encapsulated by this instance

All Implemented Interfaces:

Option<Value>

Enclosing interface:

Option<Value>

public static record Option.Some<Value>(Value value)
extends Record
implements Option<Value>

Represents a container object that holds a non-null value.

The Some class is a concrete implementation of the Option interface, used to encapsulate a value that is guaranteed to be non-null. Attempting to create an instance of Some with a null value will throw a NullPointerException.

Nested Class Summary

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

Option.None<Value>, Option.Some<Value>

Constructor Summary

Constructors

Constructor	Description
Some(Value value)	Constructs a new Some instance with the specified non-null value.

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.Option

filter, flatMap, fold, get, getOrElse, getOrElseGet, getOrNull, getOrThrow, isDefined, isEmpty, map, match, peek, stream, toOptional, toResult, toTry, zip, zipWith

Constructor Details

Some

public Some(Value value)

Constructs a new Some instance with the specified non-null value.

Parameters:

value - the non-null value to be encapsulated by this Some instance

Throws:

NullPointerException - if the provided 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