Package com.github.tonivade.purefun.type

Record Class Either.Left<L,R>

java.lang.Object

java.lang.Record

com.github.tonivade.purefun.type.Either.Left<L,R>

All Implemented Interfaces:

Applicable<Either<L,?>,R>, Bindable<Either<L,?>,R>, Mappable<Either<L,?>,R>, Kind<Either<L,?>,R>, Either<L,R>, EitherOf<L,R>, Serializable

Enclosing interface:

Either<L,R>

public static record Either.Left<L,R>(L value)
extends Record
implements Either<L,R>, Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.tonivade.purefun.core.Applicable

Applicable.Map2<F extends Applicable<F,?>,A,B>, Applicable.Map3<F extends Applicable<F,?>,A,B,C>, Applicable.Map4<F extends Applicable<F,?>,A,B,C,D>, Applicable.Map5<F extends Applicable<F,?>,A,B,C,D,E>

Nested classes/interfaces inherited from interface com.github.tonivade.purefun.type.Either

Either.Left<L,R>, Either.Right<L,R>

Field Summary

Fields

Modifier and Type	Field	Description
private final L	value	The field for the value record component.

Constructor Summary

Constructors

Constructor	Description
Left(L value)	Creates an instance of a Left record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
L	getLeft()	Returns the left value if available.
R	getRight()	Returns the right value if available.
final int	hashCode()	Returns a hash code value for this object.
boolean	isLeft()
boolean	isRight()
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 com.github.tonivade.purefun.core.Applicable

zip, zipLeft, zipRight, zipWith

Methods inherited from interface com.github.tonivade.purefun.core.Bindable

andThen

Methods inherited from interface com.github.tonivade.purefun.type.Either

ap, bimap, filter, filterNot, filterOrElse, flatMap, flatMapLeft, fold, get, getOrElse, getOrElse, getOrElseNull, left, map, mapLeft, or, orElse, right, sequence, stream, swap, toOption, toValidation

Methods inherited from interface com.github.tonivade.purefun.Kind

fix, kind

Field Details

value

private final L value

The field for the value record component.

Constructor Details

Left

public Left(L value)

Creates an instance of a Left record class.

Parameters:

value - the value for the value record component

Method Details

isLeft

public boolean isLeft()

Specified by:

isLeft in interface Either<L,R>

isRight

public boolean isRight()

Specified by:

isRight in interface Either<L,R>

getLeft

public L getLeft()

Description copied from interface: Either

Returns the left value if available. If not, it throws NoSuchElementException

Specified by:

getLeft in interface Either<L,R>

Returns:

the left value

getRight

public R getRight()

Description copied from interface: Either

Returns the right value if available. If not, it throws NoSuchElementException

Specified by:

getRight in interface Either<L,R>

Returns:

the right value

toString

public 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 L value()

Returns the value of the value record component.

Returns:

the value of the value record component