io.vavr.control

Class Either.Left<L,R>

java.lang.Object

io.vavr.control.Either.Left<L,R>

Type Parameters:

L - left component type

R - right component type

All Implemented Interfaces:

Either<L,R>, Value<R>, Serializable, Iterable<R>

Enclosing interface:

Either<L,R>

public static final class Either.Left<L,R>
extends Object
implements Either<L,R>, Serializable

The Left version of an Either.

Author:

Daniel Dietrich

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface io.vavr.control.Either

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Clarifies that values have a proper equals() method implemented.
R	get() Gets the right value if this is a Right or throws if this is a Left.
L	getLeft() Returns the left value.
int	hashCode() Clarifies that values have a proper hashCode() method implemented.
boolean	isLeft() Returns whether this Either is a Left.
boolean	isRight() Returns whether this Either is a Right.
String	stringPrefix() Returns the name of this Value type, which is used by toString().
String	toString() Clarifies that values have a proper toString() method implemented.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.vavr.control.Either

bimap, filter, filterOrElse, flatMap, fold, getOrElseGet, getOrElseThrow, isAsync, isEmpty, isLazy, isSingleValued, iterator, left, left, map, mapLeft, narrow, orElse, orElse, orElseRun, peek, peekLeft, right, right, sequence, sequenceRight, swap, toValidation, traverse, traverseRight

Methods inherited from interface io.vavr.Value

collect, collect, contains, corresponds, eq, exists, forAll, forEach, getOrElse, getOrElse, getOrElseThrow, getOrElseTry, getOrNull, narrow, out, out, spliterator, stderr, stdout, toArray, toCharSeq, toCompletableFuture, toEither, toEither, toInvalid, toInvalid, toJavaArray, toJavaArray, toJavaArray, toJavaCollection, toJavaList, toJavaList, toJavaMap, toJavaMap, toJavaMap, toJavaOptional, toJavaParallelStream, toJavaSet, toJavaSet, toJavaStream, toLeft, toLeft, toLinkedMap, toLinkedMap, toLinkedSet, toList, toMap, toMap, toOption, toPriorityQueue, toPriorityQueue, toQueue, toRight, toRight, toSet, toSortedMap, toSortedMap, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toStream, toTree, toTree, toTry, toTry, toValid, toValid, toValidation, toValidation, toVector

Method Detail

get

public R get()

Description copied from interface: Either

Gets the right value if this is a Right or throws if this is a Left.

Specified by:

get in interface Either<L,R>

Specified by:

get in interface Value<R>

Returns:

the right value

getLeft

public L getLeft()

Description copied from interface: Either

Returns the left value.

Specified by:

getLeft in interface Either<L,R>

Returns:

The left value.

isLeft

public boolean isLeft()

Description copied from interface: Either

Returns whether this Either is a 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

Returns whether this Either is a Right.

Specified by:

isRight in interface Either<L,R>

Returns:

true, if this is a Right, false otherwise

equals

public boolean equals(Object obj)

Description copied from interface: Value

Clarifies that values have a proper equals() method implemented.

See Object.equals(Object).

Specified by:

equals in interface Either<L,R>

Specified by:

equals in interface Value<R>

Overrides:

equals in class Object

Parameters:

obj - An object

Returns:

true, if this equals o, false otherwise

hashCode

public int hashCode()

Description copied from interface: Value

Clarifies that values have a proper hashCode() method implemented.

See Object.hashCode().

Specified by:

hashCode in interface Either<L,R>

Specified by:

hashCode in interface Value<R>

Overrides:

hashCode in class Object

Returns:

The hashcode of this object

stringPrefix

public String stringPrefix()

Description copied from interface: Value

Returns the name of this Value type, which is used by toString().

Specified by:

stringPrefix in interface Value<R>

Returns:

This type name.

toString

public String toString()

Description copied from interface: Value

Clarifies that values have a proper toString() method implemented.

See Object.toString().

Specified by:

toString in interface Either<L,R>

Specified by:

toString in interface Value<R>

Overrides:

toString in class Object

Returns:

A String representation of this object