Module info.jab.util

Package info.jab.util.either

Record Class Left<L,R>

java.lang.Object

java.lang.Record

info.jab.util.either.Left<L,R>

Type Parameters:

L - the type of the Left value

R - the type of the Right value

Record Components:

value - the value

All Implemented Interfaces:

Either<L,R>

public record Left<L,R>(@Nonnull L value)
extends Record
implements Either<L,R>

A record representing the Left variant of an Either.

Constructor Summary

Constructors

Constructor	Description
Left(L value)	Constructs a new Left with the given value.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
<T> T	fold(Function<? super L,? extends T> leftMapper, Function<? super R,? extends T> rightMapper)	Applies either the leftMapper function to the value if this is a Left, or the rightMapper function if this is a Right.
R	get()	Returns the value if this is a Right, otherwise throws an exception.
final int	hashCode()	Returns a hash code value for this object.
boolean	isLeft()	Checks if this is an instance of Left.
boolean	isRight()	Checks if this is an instance of Right.
final String	toString()	Returns a string representation of this record class.
L	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 info.jab.util.either.Either

combine, flatMap, getOrElse, map, orElse, swap, toOptional

Constructor Details

Left

public Left(@Nonnull
 L value)

Constructs a new Left with the given value.

Parameters:

value - the value to be contained in this Left

Throws:

NullPointerException - if value is null

Method Details

fold

public <T> T fold(Function<? super L,? extends T> leftMapper,
 Function<? super R,? extends T> rightMapper)

Description copied from interface: Either

Applies either the leftMapper function to the value if this is a Left, or the rightMapper function if this is a Right.

Specified by:

fold in interface Either<L,R>

Type Parameters:

T - the type of the result

Parameters:

leftMapper - the function to apply if this is a Left

rightMapper - the function to apply if this is a Right

Returns:

the result of applying the appropriate function

isLeft

public boolean isLeft()

Description copied from interface: Either

Checks if this is an instance of Left.

Specified by:

isLeft in interface Either<L,R>

Returns:

true if this is a Left, false otherwise

isRight

public boolean isRight()

Description copied from interface: Either

Checks if this is an instance of Right.

Specified by:

isRight in interface Either<L,R>

Returns:

true if this is a Right, false otherwise

get

public R get()

Description copied from interface: Either

Returns the value if this is a Right, otherwise throws an exception.

Specified by:

get in interface Either<L,R>

Returns:

the Right value

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

@Nonnull
public L value()

Returns the value of the value record component.

Returns:

the value of the value record component