Package io.atlassian.fugue

Class Either.Left<L,R>

java.lang.Object

io.atlassian.fugue.Either<L,R>

io.atlassian.fugue.Either.Left<L,R>

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Either<L,R>

static final class Either.Left<L,R>
extends Either<L,R>

Nested Class Summary

Nested classes/interfaces inherited from class io.atlassian.fugue.Either

Either.AbstractProjection<A,B>, Either.Left<L,R>, Either.LeftProjection, Either.Projection<A,B,L,R>, Either.Right<L,R>, Either.RightProjection

Field Summary

Fields

Modifier and Type	Field	Description
private static long	serialVersionUID
private L	value

Constructor Summary

Constructors

Constructor	Description
Left(L value)

Method Summary

Modifier and Type	Method	Description
<LL,RR> Either<LL,RR>	bimap(java.util.function.Function<? super L,? extends LL> ifLeft, java.util.function.Function<? super R,? extends RR> ifRight)	Map the given functions across the appropriate side.
boolean	equals(java.lang.Object o)
<V> V	fold(java.util.function.Function<? super L,V> ifLeft, java.util.function.Function<? super R,V> ifRight)	Applies the function to the wrapped value, applying ifLeft if this is a Left and ifRight if this is a Right.
(package private) L	getLeft()
int	hashCode()
boolean	isLeft()	Returns true if this either is a left, false otherwise.
boolean	isRight()	Returns true if this either is a right, false otherwise.
Either<R,L>	swap()	If this is a left, then return the left value in right, or vice versa.
java.lang.String	toString()

Methods inherited from class io.atlassian.fugue.Either

ap, apply, contains, exists, filter, filterOrElse, flatMap, forall, foreach, forEach, getOr, getOrElse, getOrElse, getOrError, getOrNull, getOrThrow, getRight, left, left, leftMap, leftOr, map, orElse, orElse, right, right, rightOr, sequence, toOption, toOptional, toStream, valueOr

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

value

private final L value

Constructor Detail

Left

public Left(L value)

Method Detail

getLeft

final L getLeft()

Overrides:

getLeft in class Either<L,R>

isLeft

public boolean isLeft()

Description copied from class: Either

Returns true if this either is a left, false otherwise.

Specified by:

isLeft in class Either<L,R>

Returns:

true if this either is a left, false otherwise.

isRight

public boolean isRight()

Description copied from class: Either

Returns true if this either is a right, false otherwise.

Specified by:

isRight in class Either<L,R>

Returns:

true if this either is a right, false otherwise.

swap

public Either<R,L> swap()

Description copied from class: Either

If this is a left, then return the left value in right, or vice versa.

Specified by:

swap in class Either<L,R>

Returns:

an Either that is a Left if this is a Right or a Right if this is a Left. The value remains the same.

fold

public <V> V fold(java.util.function.Function<? super L,V> ifLeft,
                  java.util.function.Function<? super R,V> ifRight)

Description copied from class: Either

Applies the function to the wrapped value, applying ifLeft if this is a Left and ifRight if this is a Right.

Specified by:

fold in class Either<L,R>

Type Parameters:

V - the destination type

Parameters:

ifLeft - the function to apply if this is a Left

ifRight - the function to apply if this is a Right

Returns:

the result of the applies function

bimap

public <LL,RR> Either<LL,RR> bimap(java.util.function.Function<? super L,? extends LL> ifLeft,
                                               java.util.function.Function<? super R,? extends RR> ifRight)

Description copied from class: Either

Map the given functions across the appropriate side.

Specified by:

bimap in class Either<L,R>

Type Parameters:

LL - the LHS type

RR - the RHS type

Parameters:

ifLeft - The function to map if this Either is a left.

ifRight - The function to map if this Either is a right.

Returns:

A new either value after mapping with the appropriate function applied.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object