Either (Either 1.3.0 API)

java.lang.Object
- de.scravy.either.Either<L,R>

Type Parameters:

L - The left type.

R - The right type.

Direct Known Subclasses:

Either.Left, Either.Right
```
public abstract class Either<L,R>
extends Object
```
The Either type (an explicit sum type for Java).

Since:

1.0.0

Author:

Julian Fleischer

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Either.Left<L,R>
The Left type.

static class Either.Right<L,R>
The Right type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Either.Left<L,R>` The `Left` type.
`static class`	`Either.Right<L,R>` The `Right` type.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<R2,B> Either<L,R2>`	`bind(EitherBiFunction<L,R,B,R2> f, B value)` Chains this either to a function that accepts its rights argument and an additional argument and returns an Either.
`<R2> Either<L,R2>`	`bind(EitherFunction<L,R,R2> f)` Chains this either to a functions that accepts its right argument and returns an Either.
`void`	`consume(EitherConsumer<L> leftConsumer, EitherConsumer<R> rightConsumer)` Consumes this Either.
`<X> X`	`fold(Function<L,X> left, Function<R,X> right)` Fold the either with functions handling the Left and the Right case.
`L`	`getLeft()` Returns the left value (if this is a left value).
`R`	`getRight()` Returns the right value (if this is a right value).
`boolean`	`isLeft()` Checks whether this `Either` is a left value.
`boolean`	`isRight()` Checks whether this `Either` is a right value.
`static <L,R> Either<L,R>`	`left(L value)` Creates a left value.
`static <L,R> Either<L,R>`	`left(L value, Class<R> rightType)` Creates a left value.
`<B,R2> Either<L,R2>`	`map(BiFunction<R,B,R2> f, B value)` Chains this either to an ordinary function.
`<R2> Either<L,R2>`	`map(Function<R,R2> f)` Chains this either to an ordinary function.
`static <L,R> Either<L,R>`	`right(R value)` Creates a right value.
`static <L,R> Either<L,R>`	`right(R value, Class<L> leftType)` Creates 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 <L,R> Either<L,R> left(L value)
```
    Creates a left value.
    
    Type Parameters:
    
    L - The left type.
    
    R - The right type.
    
    Parameters:
    
    value - The value to encapsulate as left.
    
    Returns:
    
    An either value!
    
    Since:
    
    1.0.0
  - left
```
public static <L,R> Either<L,R> left(L value,
                                     Class<R> rightType)
```
    Creates a left value.
    
    Parameters:
    
    value - The value to encapsulate as left.
    
    rightType - The right type (to aid in type inference)
    
    Returns:
    
    An either value!
    
    Since:
    
    1.1.0
  - right
```
public static <L,R> Either<L,R> right(R value)
```
    Creates a right value.
    
    Type Parameters:
    
    L - The left type.
    
    R - The right type.
    
    Parameters:
    
    value - The value to encapsulate as left.
    
    Returns:
    
    An either value!
    
    Since:
    
    1.0.0
  - right
```
public static <L,R> Either<L,R> right(R value,
                                      Class<L> leftType)
```
    Creates a right value.
    
    Parameters:
    
    value - The value to encapsulate as right.
    
    leftType - The right type (to aid in type inference)
    
    Returns:
    
    An either value!
    
    Since:
    
    1.1.0
  - isLeft
```
public boolean isLeft()
```
    Checks whether this Either is a left value.
    
    Returns:
    
    Whether this is a Left value or not.
    
    Since:
    
    1.0.0
  - isRight
```
public boolean isRight()
```
    Checks whether this Either is a right value.
    
    Returns:
    
    Whether this is a Right value or not.
    
    Since:
    
    1.0.0
  - getLeft
```
public L getLeft()
```
    Returns the left value (if this is a left value).
    
    Returns:
    
    The unwrapped left value.
    
    Throws:
    
    UnsupportedOperationException - if this is not actually a Either.Left.
    
    Since:
    
    1.0.0
  - getRight
```
public R getRight()
```
    Returns the right value (if this is a right value).
    
    Returns:
    
    The unwrapped right value.
    
    Throws:
    
    UnsupportedOperationException - if this is not actually a Either.Right.
    
    Since:
    
    1.0.0
  - bind
```
public final <R2> Either<L,R2> bind(EitherFunction<L,R,R2> f)
```
    Chains this either to a functions that accepts its right argument and returns an Either. If this either is a left value, the function will not be invoked but an either with that left value will be returned.
    
    Parameters:
    
    f - A function taking a value of the right type, producing an Either value.
    
    Returns:
    
    A new Either value which contains the result of the application of f with the right value or an Either value with the same left value as this if this was a left.
    
    Since:
    
    1.2.0
  - bind
```
public final <R2,B> Either<L,R2> bind(EitherBiFunction<L,R,B,R2> f,
                                      B value)
```
    Chains this either to a function that accepts its rights argument and an additional argument and returns an Either.
    
    Parameters:
    
    f - A function taking a value of the right type and an additional value of an arbitrary type, producing an Either value.
    
    value - An additional value which will be supplied as seconds argument to the function.
    
    Returns:
    
    A new Either value which contains the result of the application of f with the right value and the additionally supplied value or an Either value with the same left value as this if this was a left.
    
    Since:
    
    1.2.0
  - map
```
public final <R2> Either<L,R2> map(Function<R,R2> f)
```
    Chains this either to an ordinary function. The supplied function is invoked with this Eithers right value iff it is a right value or not at all if it is a left value.
```
 Either.right(3).chainOrdinary(a -> a + 1); // Right(4)
 
```
```
 Either.left(3).chainOrdinary(a -> a + 1); // Left(3)
 
```
    Parameters:
    
    f - An ordinary function, accepting a value of the right type and producing a new value.
    
    Returns:
    
    A new Right Either if this was a right value, containing the result of the application of f, or a Left Either with the Left value of this Either.
    
    Since:
    
    1.2.0
  - map
```
public final <B,R2> Either<L,R2> map(BiFunction<R,B,R2> f,
                                     B value)
```
    Chains this either to an ordinary function. The supplied function is invoked with this Eithers right value and the given additional value iff it is a right value or not at all if it is a left value.
    
    Parameters:
    
    f - An ordinary function, accepting a value of the right type and an additional value, and producing a new value.
    
    value - An additional value of arbitrary type.
    
    Returns:
    
    A new Right Either if this was a right value, containing the result of the application of f, or a Left Either with the Left value of this Either.
    
    Since:
    
    1.2.0
  - consume
```
public final void consume(EitherConsumer<L> leftConsumer,
                          EitherConsumer<R> rightConsumer)
```
    Consumes this Either.
    
    Parameters:
    
    leftConsumer -
    
    rightConsumer -
    
    Since:
    
    1.2.0
  - fold
```
public <X> X fold(Function<L,X> left,
                  Function<R,X> right)
```
    Fold the either with functions handling the Left and the Right case.
    
    Parameters:
    
    left - Function handling the left case.
    
    right - Function handling the right case.
    
    Returns:
    
    The result of the left function if this was a left or the right function if this was a right.
    
    Since:
    
    1.3.0

Class Either<L,R>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

left

left

right

right

isLeft

isRight

getLeft

getRight

bind

bind

map

map

consume

fold