Either.Left (JavaFixes 1.3.6.1 API)

java.lang.Object
- javafixes.object.DataObject
- - javafixes.object.Either<L,R>
  - - javafixes.object.Either.Left<L,R>

All Implemented Interfaces:

Value<java.lang.Object>

Enclosing class:

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

Nested Class Summary
- Nested classes/interfaces inherited from class javafixes.object.Either
  Either.Left<L,R>, Either.Right<L,R>

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)` Evaluates if object to compare is of the same DataObject type and all non-transient fields are equal as well
`<T> T`	`fold(java.util.function.Function<L,T> foldLeft, java.util.function.Function<R,T> foldRight)` Transforms a value and returns it
`L`	`getLeft()` Returns wrapped value in case the `Either` is of type `Left`.
`<T extends java.lang.Throwable> L`	`getLeftOrThrow(java.util.function.Supplier<? extends T> exceptionSupplier)` Returns wrapped value in case the `Either` is of type `Left`.
`R`	`getRight()` Returns wrapped value in case the `Either` is of type `Right`.
`<T extends java.lang.Throwable> R`	`getRightOrThrow(java.util.function.Supplier<? extends T> exceptionSupplier)` Returns wrapped value in case the `Either` is of type `Right`.
`<TL extends java.lang.Throwable,TR extends java.lang.Throwable> Either<L,R>`	`handle(ValueHandler<? super L,? extends TL> leftValueHandler, ValueHandler<? super R,? extends TR> rightValueHandler)` Executes provided `leftValueHandler` if value is defined as `Left` `Either`.
`<T extends java.lang.Throwable> Either<L,R>`	`handleLeft(ValueHandler<? super L,? extends T> leftValueHandler)` Executes provided `leftValueHandler` if value is defined as `Left` `Either`.
`<T extends java.lang.Throwable> Either<L,R>`	`handleRight(ValueHandler<? super R,? extends T> rightValueHandler)` Executes provided `rightValueHandler` if value is defined as `Right` `Either`.
`int`	`hashCode()` Returns hashCode calculated using reflection
`<T extends java.lang.Throwable> Either<L,R>`	`ifLeftThrow(java.util.function.Function<L,? extends T> exceptionSupplier)` Throws `Exception` provided via `exceptionSupplier` if value is defined as `Left` `Either`.
`<T extends java.lang.Throwable> Either<L,R>`	`ifRightThrow(java.util.function.Function<R,? extends T> exceptionSupplier)` Throws `Exception` provided via `exceptionSupplier` if value is defined as `Right` `Either`.
`boolean`	`isLeft()` Returns true if value is wrapped into a `Left` `Either`
`boolean`	`isRight()` Returns true if value is wrapped into a `Right` `Either`
`<L2,R2> Either<L2,R2>`	`map(java.util.function.Function<L,L2> leftValueMapper, java.util.function.Function<R,R2> rightValueMapper)` Applies provided `leftValueMapper` to transform wrapped `value` if value is defined as `Left` `Either`.
`<L2> Either<L2,R>`	`mapLeft(java.util.function.Function<L,L2> leftValueMapper)` Applies provided `leftValueMapper` to transform wrapped `value` if value is defined as `Left` `Either`.
`<R2> Either<L,R2>`	`mapRight(java.util.function.Function<R,R2> rightValueMapper)` Applies provided `rightValueMapper` to transform wrapped `value` if value is defined as `Right` `Either`.
`Either<R,L>`	`swap()` Swaps left and right value of an `Either`
`L`	`value()` Returns left value

Methods inherited from class javafixes.object.Either
left, right

Methods inherited from class javafixes.object.DataObject
toString

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

Methods inherited from interface javafixes.object.Value
getValue

- Method Detail
  - swap
```
public Either<R,L> swap()
```
    Description copied from class: Either
    
    Swaps left and right value of an Either
    
    Specified by:
    
    swap in class Either<L,R>
    
    Returns:
    
    Either with swapped left and right values
  - isLeft
```
public boolean isLeft()
```
    Description copied from class: Either
    
    Returns true if value is wrapped into a Left Either
    
    Specified by:
    
    isLeft in class Either<L,R>
    
    Returns:
    
    true if is Left Either
  - isRight
```
public boolean isRight()
```
    Description copied from class: Either
    
    Returns true if value is wrapped into a Right Either
    
    Specified by:
    
    isRight in class Either<L,R>
    
    Returns:
    
    true if is Right Either
  - getLeft
```
public L getLeft()
```
    Description copied from class: Either
    
    Returns wrapped value in case the Either is of type Left. Throws a NoSuchElementException in case the Either is of type Right.
    
    Specified by:
    
    getLeft in class Either<L,R>
    
    Returns:
    
    value in case the Either is of type Left
  - getRight
```
public R getRight()
           throws java.util.NoSuchElementException
```
    Description copied from class: Either
    
    Returns wrapped value in case the Either is of type Right. Throws a NoSuchElementException in case the Either is of type Left.
    
    Specified by:
    
    getRight in class Either<L,R>
    
    Returns:
    
    value in case the Either is of type Right
    
    Throws:
    
    java.util.NoSuchElementException - in case the Either is of type Left
  - getLeftOrThrow
```
public <T extends java.lang.Throwable> L getLeftOrThrow(java.util.function.Supplier<? extends T> exceptionSupplier)
```
    Description copied from class: Either
    
    Returns wrapped value in case the Either is of type Left. Throws Exception provided via exceptionSupplier if value is defined as Right Either.
    
    Specified by:
    
    getLeftOrThrow in class Either<L,R>
    
    Type Parameters:
    
    T - type of Exception that will be provided by exceptionSupplier
    
    Parameters:
    
    exceptionSupplier - that should provide Exception in case of Right Either
    
    Returns:
    
    value in case the Either is of type Left
  - getRightOrThrow
```
public <T extends java.lang.Throwable> R getRightOrThrow(java.util.function.Supplier<? extends T> exceptionSupplier)
                                                  throws T extends java.lang.Throwable
```
    Description copied from class: Either
    
    Returns wrapped value in case the Either is of type Right. Throws Exception provided via exceptionSupplier if value is defined as Left Either.
    
    Specified by:
    
    getRightOrThrow in class Either<L,R>
    
    Type Parameters:
    
    T - type of Exception that will be provided by exceptionSupplier
    
    Parameters:
    
    exceptionSupplier - that should provide Exception in case of Left Either
    
    Returns:
    
    value in case the Either is of type Right
    
    Throws:
    
    T - Exception provided via exceptionSupplier if value is defined as Left Either.
    
    T extends java.lang.Throwable
  - map
```
public <L2,R2> Either<L2,R2> map(java.util.function.Function<L,L2> leftValueMapper,
                                 java.util.function.Function<R,R2> rightValueMapper)
```
    Description copied from class: Either
    
    Applies provided leftValueMapper to transform wrapped value if value is defined as Left Either. Applies provided rightValueMapper to transform wrapped value if value is defined as Right Either.
    
    Specified by:
    
    map in class Either<L,R>
    
    Type Parameters:
    
    L2 - new type of Left Either value
    
    R2 - new type of Right Either value
    
    Parameters:
    
    leftValueMapper - function that is applied Left Either value
    
    rightValueMapper - function that is applied Right Either value
    
    Returns:
    
    modified Either
  - mapLeft
```
public <L2> Either<L2,R> mapLeft(java.util.function.Function<L,L2> leftValueMapper)
```
    Description copied from class: Either
    
    Applies provided leftValueMapper to transform wrapped value if value is defined as Left Either. The leftValueMapper is ignored if value is defined as Right Either.
    
    Specified by:
    
    mapLeft in class Either<L,R>
    
    Type Parameters:
    
    L2 - new type of Left Either value
    
    Parameters:
    
    leftValueMapper - function that is applied Left Either value
    
    Returns:
    
    modified Either
  - mapRight
```
public <R2> Either<L,R2> mapRight(java.util.function.Function<R,R2> rightValueMapper)
```
    Description copied from class: Either
    
    Applies provided rightValueMapper to transform wrapped value if value is defined as Right Either. The rightValueMapper is ignored if value is defined as Left Either.
    
    Specified by:
    
    mapRight in class Either<L,R>
    
    Type Parameters:
    
    R2 - new type of Right Either value
    
    Parameters:
    
    rightValueMapper - function that is applied Right Either value
    
    Returns:
    
    modified Either
  - fold
```
public <T> T fold(java.util.function.Function<L,T> foldLeft,
                  java.util.function.Function<R,T> foldRight)
```
    Description copied from class: Either
    
    Transforms a value and returns it
    
    Specified by:
    
    fold in class Either<L,R>
    
    Type Parameters:
    
    T - type of output value
    
    Parameters:
    
    foldLeft - function to map Left value into output value
    
    foldRight - function to map Right value into output value
    
    Returns:
    
    transformed value
  - handleLeft
```
public <T extends java.lang.Throwable> Either<L,R> handleLeft(ValueHandler<? super L,? extends T> leftValueHandler)
                                                       throws T extends java.lang.Throwable
```
    Description copied from class: Either
    
    Executes provided leftValueHandler if value is defined as Left Either. The action is ignored if value is defined as Right Either.
    
    Specified by:
    
    handleLeft in class Either<L,R>
    
    Type Parameters:
    
    T - class of potential Throwable thrown by leftValueHandler
    
    Parameters:
    
    leftValueHandler - action that is executed for Left Either
    
    Returns:
    
    the same instance of Either to allow method chaining
    
    Throws:
    
    T - in case the leftValueHandler throws T
    
    T extends java.lang.Throwable
  - handleRight
```
public <T extends java.lang.Throwable> Either<L,R> handleRight(ValueHandler<? super R,? extends T> rightValueHandler)
```
    Description copied from class: Either
    
    Executes provided rightValueHandler if value is defined as Right Either. The action is ignored if value is defined as Left Either.
    
    Specified by:
    
    handleRight in class Either<L,R>
    
    Type Parameters:
    
    T - class of potential Throwable thrown by rightValueHandler
    
    Parameters:
    
    rightValueHandler - action that is executed for Right Either
    
    Returns:
    
    the same instance of Either to allow method chaining
  - handle
```
public <TL extends java.lang.Throwable,TR extends java.lang.Throwable> Either<L,R> handle(ValueHandler<? super L,? extends TL> leftValueHandler,
                                                                                          ValueHandler<? super R,? extends TR> rightValueHandler)
                                                                                   throws TL extends java.lang.Throwable
```
    Description copied from class: Either
    
    Executes provided leftValueHandler if value is defined as Left Either. Executes provided rightValueHandler if value is defined as Right Either.
    
    Specified by:
    
    handle in class Either<L,R>
    
    Type Parameters:
    
    TL - class of potential Throwable thrown by leftValueHandler
    
    TR - class of potential Throwable thrown by rightValueHandler
    
    Parameters:
    
    leftValueHandler - action that is executed for Left Either
    
    rightValueHandler - action that is executed for Right Either
    
    Returns:
    
    the same instance of Either to allow method chaining
    
    Throws:
    
    TL - in case the leftValueHandler throws T
    
    TL extends java.lang.Throwable
  - ifLeftThrow
```
public <T extends java.lang.Throwable> Either<L,R> ifLeftThrow(java.util.function.Function<L,? extends T> exceptionSupplier)
                                                        throws T extends java.lang.Throwable
```
    Description copied from class: Either
    
    Throws Exception provided via exceptionSupplier if value is defined as Left Either. The exceptionSupplier is ignored if value is defined as Right Either.
    
    Specified by:
    
    ifLeftThrow in class Either<L,R>
    
    Type Parameters:
    
    T - type of Exception that will be provided by exceptionSupplier
    
    Parameters:
    
    exceptionSupplier - that should provide Exception in case of Left Either
    
    Returns:
    
    the same instance to allow method chaining
    
    Throws:
    
    T - Exception provided via exceptionSupplier if value is defined as Left Either.
    
    T extends java.lang.Throwable
  - ifRightThrow
```
public <T extends java.lang.Throwable> Either<L,R> ifRightThrow(java.util.function.Function<R,? extends T> exceptionSupplier)
```
    Description copied from class: Either
    
    Throws Exception provided via exceptionSupplier if value is defined as Right Either. The exceptionSupplier is ignored if value is defined as Left Either.
    
    Specified by:
    
    ifRightThrow in class Either<L,R>
    
    Type Parameters:
    
    T - type of Exception that will be provided by exceptionSupplier
    
    Parameters:
    
    exceptionSupplier - that should provide Exception in case of Right Either
    
    Returns:
    
    the same instance to allow method chaining
  - value
```
public L value()
```
    Returns left value
    
    Specified by:
    
    value in interface Value<java.lang.Object>
    
    Specified by:
    
    value in class Either<L,R>
    
    Returns:
    
    left value
  - equals
```
public boolean equals(java.lang.Object o)
```
    Description copied from class: DataObject
    
    Evaluates if object to compare is of the same DataObject type and all non-transient fields are equal as well
    
    Overrides:
    
    equals in class DataObject
    
    Parameters:
    
    o - value to compare to
    
    Returns:
    
    true if other value is of the same DataObject type and all non-transient field are equal. Otherwise returns false
  - hashCode
```
public int hashCode()
```
    Description copied from class: DataObject
    
    Returns hashCode calculated using reflection
    
    Overrides:
    
    hashCode in class DataObject
    
    Returns:
    
    hashCode

Class Either.Left<L,R>

Nested Class Summary

Nested classes/interfaces inherited from class javafixes.object.Either

Method Summary

Methods inherited from class javafixes.object.Either

Methods inherited from class javafixes.object.DataObject

Methods inherited from class java.lang.Object

Methods inherited from interface javafixes.object.Value

Method Detail

swap

isLeft

isRight

getLeft

getRight

getLeftOrThrow

getRightOrThrow

map

mapLeft

mapRight

fold

handleLeft

handleRight

handle

ifLeftThrow

ifRightThrow

value

equals

hashCode