Either (Fusion 1.0.5-forge-mc1.12 API)

java.lang.Object
- com.supermartijn642.fusion.api.util.Either<X,Y>

public abstract class Either<X,Y>
extends java.lang.Object

Created 09/09/2022 by SuperMartijn642

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract <S> S`	`flatMap(java.util.function.Function<X,S> mapLeft, java.util.function.Function<Y,S> mapRight)` Applies the respective mapper to obtain an object of type `S`.
`abstract void`	`ifLeft(java.util.function.Consumer<X> consumer)` Applies the given consumer if this either is a left value.
`abstract void`	`ifRight(java.util.function.Consumer<Y> consumer)` Applies the given consumer if this either is a right value.
`abstract boolean`	`isLeft()` Whether the either is a left value or not.
`abstract boolean`	`isRight()` Whether the either is a right value or not.
`abstract X`	`left()` Will take this either as a left value.
`static <X,Y> Either<X,Y>`	`left(X object)` Creates a left either instance with the given value.
`abstract X`	`leftOrElse(X other)` Will take this either as a left value.
`abstract X`	`leftOrElseGet(java.util.function.Supplier<X> other)` Will take this either as a left value.
`X`	`leftOrNull()` Will take this either as a left value.
`<R,S> Either<R,S>`	`map(java.util.function.Function<X,R> mapLeft, java.util.function.Function<Y,S> mapRight)` Applies the respective mapper given whether this either is a left or right value.
`abstract <S> Either<S,Y>`	`mapLeft(java.util.function.Function<X,S> mapper)` Applies the given mapper if this either is a left value.
`abstract <S> Either<X,S>`	`mapRight(java.util.function.Function<Y,S> mapper)` Applies the given mapper if this either is a right value.
`abstract Y`	`right()` Will take this either as a right value.
`static <X,Y> Either<X,Y>`	`right(Y object)` Creates a right either instance with the given value.
`abstract Y`	`rightOrElse(Y other)` Will take this either as a right value.
`abstract Y`	`rightOrElseGet(java.util.function.Supplier<Y> other)` Will take this either as a right value.
`Y`	`rightOrNull()` Will take this either as a right value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - left
```
public static <X,Y> Either<X,Y> left(X object)
```
    Creates a left either instance with the given value.
  - right
```
public static <X,Y> Either<X,Y> right(Y object)
```
    Creates a right either instance with the given value.
  - isLeft
```
public abstract boolean isLeft()
```
    Whether the either is a left value or not.
  - isRight
```
public abstract boolean isRight()
```
    Whether the either is a right value or not.
  - left
```
public abstract X left()
```
    Will take this either as a left value.
    
    Throws:
    
    java.util.NoSuchElementException - if the either is a right value
  - right
```
public abstract Y right()
```
    Will take this either as a right value.
    
    Throws:
    
    java.util.NoSuchElementException - if the either is a left value
  - leftOrElse
```
public abstract X leftOrElse(X other)
```
    Will take this either as a left value. If this either is a right value, the given alternative will be returned.
  - rightOrElse
```
public abstract Y rightOrElse(Y other)
```
    Will take this either as a right value. If this either is a left value, the given alternative will be returned.
  - leftOrElseGet
```
public abstract X leftOrElseGet(java.util.function.Supplier<X> other)
```
    Will take this either as a left value. If this either is a right value, the given alternative will be resolved and returned.
  - rightOrElseGet
```
public abstract Y rightOrElseGet(java.util.function.Supplier<Y> other)
```
    Will take this either as a right value. If this either is a left value, the given alternative will be resolved and returned.
  - leftOrNull
```
public X leftOrNull()
```
    Will take this either as a left value. If this either is a right value, null will be returned.
  - rightOrNull
```
public Y rightOrNull()
```
    Will take this either as a right value. If this either is a left value, null will be returned.
  - mapLeft
```
public abstract <S> Either<S,Y> mapLeft(java.util.function.Function<X,S> mapper)
```
    Applies the given mapper if this either is a left value.
  - mapRight
```
public abstract <S> Either<X,S> mapRight(java.util.function.Function<Y,S> mapper)
```
    Applies the given mapper if this either is a right value.
  - map
```
public <R,S> Either<R,S> map(java.util.function.Function<X,R> mapLeft,
                             java.util.function.Function<Y,S> mapRight)
```
    Applies the respective mapper given whether this either is a left or right value.
  - flatMap
```
public abstract <S> S flatMap(java.util.function.Function<X,S> mapLeft,
                              java.util.function.Function<Y,S> mapRight)
```
    Applies the respective mapper to obtain an object of type S.
  - ifLeft
```
public abstract void ifLeft(java.util.function.Consumer<X> consumer)
```
    Applies the given consumer if this either is a left value.
  - ifRight
```
public abstract void ifRight(java.util.function.Consumer<Y> consumer)
```
    Applies the given consumer if this either is a right value.

Class Either<X,Y>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

left

right

isLeft

isRight

left

right

leftOrElse

rightOrElse

leftOrElseGet

rightOrElseGet

leftOrNull

rightOrNull

mapLeft

mapRight

map

flatMap

ifLeft

ifRight