LazyEither.CompletableEither (cyclops 10.0.0-RC1 API)

java.lang.Object
- cyclops.control.LazyEither.CompletableEither<ORG,RT>

All Implemented Interfaces:

Convert<Higher<Higher<DataWitness.either,java.lang.Throwable>,RT>>, Higher<Higher<DataWitness.either,java.lang.Throwable>,RT>, Higher2<DataWitness.either,java.lang.Throwable,RT>, Sealed2<java.lang.Throwable,RT>, SealedOr<RT>, Unit<RT>, Filters<RT>, To<Either<java.lang.Throwable,RT>>, BiTransformable<java.lang.Throwable,RT>, Transformable<RT>, OrElseValue<RT,Either<java.lang.Throwable,RT>>, Completable<ORG>, Value<RT>, Either<java.lang.Throwable,RT>, LazyEither<java.lang.Throwable,RT>, io.kindedj.Hk<Higher<DataWitness.either,java.lang.Throwable>,RT>, java.io.Serializable, java.lang.Iterable<RT>, org.reactivestreams.Publisher<RT>

Enclosing interface:

LazyEither<LT,RT>
```
public static class LazyEither.CompletableEither<ORG,RT>
extends java.lang.Object
implements LazyEither<java.lang.Throwable,RT>, Completable<ORG>
```
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface cyclops.control.LazyEither
  LazyEither.CompletableEither<ORG,RT>, LazyEither.Lazy<ST,PT>, LazyEither.Left<ST,PT>, LazyEither.Right<ST,PT>
- Nested classes/interfaces inherited from interface com.oath.cyclops.types.reactive.Completable
  Completable.CompletablePublisher<T>

Field Summary

Fields
Modifier and Type Field and Description

Completable.CompletablePublisher<ORG> complete

LazyEither<java.lang.Throwable,RT> either

Fields
Modifier and Type	Field and Description
`Completable.CompletablePublisher<ORG>`	`complete`
`LazyEither<java.lang.Throwable,RT>`	`either`

Constructor Summary

Constructors
Constructor and Description

CompletableEither()

Constructors
Constructor and Description
`CompletableEither()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`complete(ORG done)`
`boolean`	`completeExceptionally(java.lang.Throwable error)`
`boolean`	`equals(java.lang.Object obj)`
`Maybe<RT>`	`filter(java.util.function.Predicate<? super RT> test)` Keep only elements for which the supplied predicates hold e.g.
`<RT1> LazyEither<java.lang.Throwable,RT1>`	`flatMap(java.util.function.Function<? super RT,? extends Either<? extends java.lang.Throwable,? extends RT1>> mapper)`
`<LT1> LazyEither<LT1,RT>`	`flatMapLeft(java.util.function.Function<? super java.lang.Throwable,? extends Either<LT1,RT>> mapper)` Perform a flatMap operation on the Left type
`LazyEither<java.lang.Throwable,RT>`	`flatMapLeftToRight(java.util.function.Function<? super java.lang.Throwable,? extends Either<java.lang.Throwable,RT>> fn)` A flatMap operation that keeps the Left and Right types the same
`<R> R`	`fold(java.util.function.Function<? super RT,? extends R> present, java.util.function.Supplier<? extends R> absent)`
`<R> R`	`fold(java.util.function.Function<? super java.lang.Throwable,? extends R> secondary, java.util.function.Function<? super RT,? extends R> primary)` Visitor pattern for this Ior.
`Option<RT>`	`get()`
`Option<java.lang.Throwable>`	`getLeft()`
`int`	`hashCode()`
`boolean`	`isDone()`
`boolean`	`isFailed()`
`boolean`	`isLeft()`
`boolean`	`isRight()`
`java.lang.Throwable`	`leftOrElse(java.lang.Throwable alt)`
`ReactiveSeq<java.lang.Throwable>`	`leftToStream()`
`<R> LazyEither<java.lang.Throwable,R>`	`map(java.util.function.Function<? super RT,? extends R> fn)` Transform this functor using the supplied transformation function
`<R> LazyEither<R,RT>`	`mapLeft(java.util.function.Function<? super java.lang.Throwable,? extends R> fn)` Always transform the Left type of this Either if it is present using the provided transformation function
`LazyEither<java.lang.Throwable,RT>`	`mapLeftToRight(java.util.function.Function<? super java.lang.Throwable,? extends RT> fn)` If this Either contains the Left type, transform it's value so that it contains the Right type
`LazyEither<java.lang.Throwable,RT>`	`peek(java.util.function.Consumer<? super RT> action)` Peek at the current value of this Transformable, without transforming it
`LazyEither<java.lang.Throwable,RT>`	`peekLeft(java.util.function.Consumer<? super java.lang.Throwable> action)` Peek at the Left type value if present
`Either<java.lang.Throwable,RT>`	`recover(RT value)`
`Either<java.lang.Throwable,RT>`	`recover(java.util.function.Supplier<? extends RT> value)`
`Either<java.lang.Throwable,RT>`	`recoverWith(java.util.function.Supplier<? extends Either<java.lang.Throwable,RT>> fn)`
`LazyEither<RT,java.lang.Throwable>`	`swap()` Swap types so operations directly affect the current (pre-swap) Left type
`Ior<java.lang.Throwable,RT>`	`toIor()`

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

Methods inherited from interface cyclops.control.LazyEither
accumulate, applyAny, arity, async, bimap, bipeek, combine, combine, combineToLazySeq, combineToList, consumeAny, either, filter, forEach2, forEach3, forEach4, fromEither, fromFuture, fromIterable, fromLazy, fromPublisher, isPresent, lazySeq, left, leftEval, narrow, narrowK, narrowK2, nest, right, rightEval, sequence, sequenceLeft, sequenceRight, tailRec, toEither, toEither, toEitherTrampoline, toTrampoline, toTrampoline, toTrampoline, traverse, traverseLeft, traverseRight, unit, visitAny, visitAny, zip, zip

Methods inherited from interface cyclops.control.Either
accumulateLeft, accumulateLeft, accumulateLeft, accumulateRight, accumulateRight, accumulateRight, applyAny, combineToVector, consumeAny, filterNot, fromIterable, nestedEval, notNull, ofType, sequence, sequenceLeft, sequenceRight, tailRec, traverse, visitAny, visitAny, widen

Methods inherited from interface com.oath.cyclops.types.foldable.To
to

Methods inherited from interface com.oath.cyclops.types.OrElseValue
orElseUse, orElseUse

Methods inherited from interface com.oath.cyclops.types.Value
asSupplier, collect, fold, forEach, generate, iterate, iterator, mkString, newSubscriber, nonEmptyList, nonEmptyListGet, orElse, orElseGet, print, print, printErr, printOut, stream, subscribe, toLazyEither, toLeft, toMaybe, toOption, toOptional, toRight, toTry, toTry, toTry, transform

Methods inherited from interface java.lang.Iterable
spliterator

Methods inherited from interface com.oath.cyclops.hkt.Higher
applyHKT_, applyHKT, applyHKT

Methods inherited from interface com.oath.cyclops.hkt.Convert
convert

- Field Detail
  - complete
```
public final Completable.CompletablePublisher<ORG> complete
```
  - either
```
public final LazyEither<java.lang.Throwable,RT> either
```
- Constructor Detail
  - CompletableEither
```
public CompletableEither()
```
- Method Detail
  - recover
```
public Either<java.lang.Throwable,RT> recover(java.util.function.Supplier<? extends RT> value)
```
    Specified by:
    
    recover in interface Either<java.lang.Throwable,RT>
  - recover
```
public Either<java.lang.Throwable,RT> recover(RT value)
```
    Specified by:
    
    recover in interface Either<java.lang.Throwable,RT>
  - recoverWith
```
public Either<java.lang.Throwable,RT> recoverWith(java.util.function.Supplier<? extends Either<java.lang.Throwable,RT>> fn)
```
    Specified by:
    
    recoverWith in interface Either<java.lang.Throwable,RT>
  - isFailed
```
public boolean isFailed()
```
    Specified by:
    
    isFailed in interface Completable<ORG>
  - isDone
```
public boolean isDone()
```
    Specified by:
    
    isDone in interface Completable<ORG>
  - complete
```
public boolean complete(ORG done)
```
    Specified by:
    
    complete in interface Completable<ORG>
  - completeExceptionally
```
public boolean completeExceptionally(java.lang.Throwable error)
```
    Specified by:
    
    completeExceptionally in interface Completable<ORG>
  - filter
```
public Maybe<RT> filter(java.util.function.Predicate<? super RT> test)
```
    Description copied from interface: Filters
    Keep only elements for which the supplied predicates hold e.g.
```
 

     of(1,2,3).filter(i->i>2);

     //[3]

 
 
```
    Specified by:
    
    filter in interface Filters<RT>
    
    Specified by:
    
    filter in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    filter in interface LazyEither<java.lang.Throwable,RT>
    
    Parameters:
    
    test - to filter elements by, retaining matches
    
    Returns:
    
    Filters with elements removed where the predicate does not hold
  - map
```
public <R> LazyEither<java.lang.Throwable,R> map(java.util.function.Function<? super RT,? extends R> fn)
```
    Description copied from interface: Transformable
    Transform this functor using the supplied transformation function
```
 


    of(1,2,3).map(i->i*2)

    //[2,4,6]

 
 
```
    Specified by:
    
    map in interface Transformable<RT>
    
    Specified by:
    
    map in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    map in interface LazyEither<java.lang.Throwable,RT>
    
    Parameters:
    
    fn - Transformation function
    
    Returns:
    
    Transformed Transformable
  - peek
```
public LazyEither<java.lang.Throwable,RT> peek(java.util.function.Consumer<? super RT> action)
```
    Description copied from interface: Transformable
    Peek at the current value of this Transformable, without transforming it
```
 


    of(1,2,3).map(System.out::println)

    1
    2
    3

 
 
```
    Specified by:
    
    peek in interface Transformable<RT>
    
    Specified by:
    
    peek in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    peek in interface LazyEither<java.lang.Throwable,RT>
    
    Parameters:
    
    action - Consumer that recieves each element from this Transformable
    
    Returns:
    
    Transformable that will peek at each value
  - swap
```
public LazyEither<RT,java.lang.Throwable> swap()
```
    Description copied from interface: LazyEither
    Swap types so operations directly affect the current (pre-swap) Left type
```
  

    Either.left("hello")
       .map(v->v+" world")
    //Either.seconary["hello"]

    Either.left("hello")
       .swap()
       .map(v->v+" world")
       .swap()
    //Either.seconary["hello world"]
  
  
```
    Specified by:
    
    swap in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    swap in interface LazyEither<java.lang.Throwable,RT>
    
    Returns:
    
    Swap the right and left types, allowing operations directly on what was the Left type
  - toIor
```
public Ior<java.lang.Throwable,RT> toIor()
```
    Specified by:
    
    toIor in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    toIor in interface LazyEither<java.lang.Throwable,RT>
  - get
```
public Option<RT> get()
```
    Specified by:
    
    get in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    get in interface LazyEither<java.lang.Throwable,RT>
  - getLeft
```
public Option<java.lang.Throwable> getLeft()
```
    Specified by:
    
    getLeft in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    getLeft in interface LazyEither<java.lang.Throwable,RT>
    
    Returns:
    
    The Left Value if present, otherwise null
  - leftOrElse
```
public java.lang.Throwable leftOrElse(java.lang.Throwable alt)
```
    Specified by:
    
    leftOrElse in interface Either<java.lang.Throwable,RT>
  - leftToStream
```
public ReactiveSeq<java.lang.Throwable> leftToStream()
```
    Specified by:
    
    leftToStream in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    leftToStream in interface LazyEither<java.lang.Throwable,RT>
    
    Returns:
    
    A Stream containing the left value if present, otherwise an zero Stream
  - flatMap
```
public <RT1> LazyEither<java.lang.Throwable,RT1> flatMap(java.util.function.Function<? super RT,? extends Either<? extends java.lang.Throwable,? extends RT1>> mapper)
```
    Specified by:
    
    flatMap in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    flatMap in interface LazyEither<java.lang.Throwable,RT>
  - isRight
```
public boolean isRight()
```
    Specified by:
    
    isRight in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    isRight in interface LazyEither<java.lang.Throwable,RT>
    
    Returns:
    
    True if this is a right Either
  - isLeft
```
public boolean isLeft()
```
    Specified by:
    
    isLeft in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    isLeft in interface LazyEither<java.lang.Throwable,RT>
    
    Returns:
    
    True if this is a left Either
  - flatMapLeftToRight
```
public LazyEither<java.lang.Throwable,RT> flatMapLeftToRight(java.util.function.Function<? super java.lang.Throwable,? extends Either<java.lang.Throwable,RT>> fn)
```
    Description copied from interface: LazyEither
    
    A flatMap operation that keeps the Left and Right types the same
    
    Specified by:
    
    flatMapLeftToRight in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    flatMapLeftToRight in interface LazyEither<java.lang.Throwable,RT>
    
    Parameters:
    
    fn - Transformation function
    
    Returns:
    
    Either
  - flatMapLeft
```
public <LT1> LazyEither<LT1,RT> flatMapLeft(java.util.function.Function<? super java.lang.Throwable,? extends Either<LT1,RT>> mapper)
```
    Description copied from interface: LazyEither
    
    Perform a flatMap operation on the Left type
    
    Specified by:
    
    flatMapLeft in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    flatMapLeft in interface LazyEither<java.lang.Throwable,RT>
    
    Parameters:
    
    mapper - Flattening transformation function
    
    Returns:
    
    Either containing the value inside the result of the transformation function as the Left value, if the Left type was present
  - fold
```
public <R> R fold(java.util.function.Function<? super java.lang.Throwable,? extends R> secondary,
                  java.util.function.Function<? super RT,? extends R> primary)
```
    Description copied from interface: LazyEither
    Visitor pattern for this Ior. Execute the left function if this Either contains an element of the left type Execute the right function if this Either contains an element of the right type
```
 
  Either.right(10)
     .visit(left->"no", right->"yes")
  //Either["yes"]

        Either.left(90)
           .visit(left->"no", right->"yes")
        //Either["no"]



 
 
```
    Specified by:
    
    fold in interface Sealed2<java.lang.Throwable,RT>
    
    Specified by:
    
    fold in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    fold in interface LazyEither<java.lang.Throwable,RT>
    
    Parameters:
    
    secondary - Function to execute if this is a Left Either
    
    primary - Function to execute if this is a Right Ior
    
    Returns:
    
    Result of executing the appropriate function
  - peekLeft
```
public LazyEither<java.lang.Throwable,RT> peekLeft(java.util.function.Consumer<? super java.lang.Throwable> action)
```
    Description copied from interface: LazyEither
    
    Peek at the Left type value if present
    
    Specified by:
    
    peekLeft in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    peekLeft in interface LazyEither<java.lang.Throwable,RT>
    
    Parameters:
    
    action - Consumer to peek at the Left type value
    
    Returns:
    
    Either with the same values as before
  - mapLeft
```
public <R> LazyEither<R,RT> mapLeft(java.util.function.Function<? super java.lang.Throwable,? extends R> fn)
```
    Description copied from interface: LazyEither
    
    Always transform the Left type of this Either if it is present using the provided transformation function
    
    Specified by:
    
    mapLeft in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    mapLeft in interface LazyEither<java.lang.Throwable,RT>
    
    Parameters:
    
    fn - Transformation function for Left types
    
    Returns:
    
    Either with Left type transformed
  - mapLeftToRight
```
public LazyEither<java.lang.Throwable,RT> mapLeftToRight(java.util.function.Function<? super java.lang.Throwable,? extends RT> fn)
```
    Description copied from interface: LazyEither
    
    If this Either contains the Left type, transform it's value so that it contains the Right type
    
    Specified by:
    
    mapLeftToRight in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    mapLeftToRight in interface LazyEither<java.lang.Throwable,RT>
    
    Parameters:
    
    fn - Function to transform left type to right
    
    Returns:
    
    Either with left type mapped to right
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - fold
```
public <R> R fold(java.util.function.Function<? super RT,? extends R> present,
                  java.util.function.Supplier<? extends R> absent)
```
    Specified by:
    
    fold in interface SealedOr<RT>

Class LazyEither.CompletableEither<ORG,RT>

Nested Class Summary

Nested classes/interfaces inherited from interface cyclops.control.LazyEither

Nested classes/interfaces inherited from interface com.oath.cyclops.types.reactive.Completable

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface cyclops.control.LazyEither

Methods inherited from interface cyclops.control.Either

Methods inherited from interface com.oath.cyclops.types.foldable.To

Methods inherited from interface com.oath.cyclops.types.OrElseValue

Methods inherited from interface com.oath.cyclops.types.Value

Methods inherited from interface java.lang.Iterable

Methods inherited from interface com.oath.cyclops.hkt.Higher

Methods inherited from interface com.oath.cyclops.hkt.Convert

Field Detail

complete

either

Constructor Detail

CompletableEither

Method Detail

recover

recover

recoverWith

isFailed

isDone

complete

completeExceptionally

filter

map

peek

swap

toIor

get

getLeft

leftOrElse

leftToStream

flatMap

isRight

isLeft

flatMapLeftToRight

flatMapLeft

fold

peekLeft

mapLeft

mapLeftToRight

hashCode

equals

fold