LazyEither5.CompletableEither5 (cyclops 10.1.0 API)

java.lang.Object
- cyclops.control.LazyEither5.CompletableEither5<ORG,LT1,LT2,LT3,RT>

All Implemented Interfaces:

Sealed5<java.lang.Throwable,LT1,LT2,LT3,RT>, SealedOr<RT>, Unit<RT>, Filters<RT>, To<LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>>, BiTransformable<LT3,RT>, Transformable<RT>, OrElseValue<RT,LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>>, Completable<ORG>, Value<RT>, LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>, java.lang.Iterable<RT>, org.reactivestreams.Publisher<RT>

Enclosing interface:

LazyEither5<LT1,LT2,LT3,LT4,RT>
```
public static class LazyEither5.CompletableEither5<ORG,LT1,LT2,LT3,RT>
extends java.lang.Object
implements LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>, Completable<ORG>
```

Nested Class Summary
- Nested classes/interfaces inherited from interface cyclops.control.LazyEither5
  LazyEither5.CompletableEither5<ORG,LT1,LT2,LT3,RT>, LazyEither5.Lazy<ST,M,M2,M3,PT>, LazyEither5.Left1<ST,M,M2,M3,PT>, LazyEither5.Left2<ST,M,M2,M3,PT>, LazyEither5.Left3<ST,M,M2,M3,PT>, LazyEither5.Left4<ST,M,M2,M3,PT>, LazyEither5.Right<ST,M,M2,M3,PT>

Field Summary

Fields
Modifier and Type Field and Description

java.util.concurrent.CompletableFuture<ORG> complete

LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT> either

Fields
Modifier and Type	Field and Description
`java.util.concurrent.CompletableFuture<ORG>`	`complete`
`LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>`	`either`

Constructor Summary

Constructors
Constructor and Description

CompletableEither5()

Constructors
Constructor and Description
`CompletableEither5()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<R1,R2> LazyEither5<java.lang.Throwable,LT1,LT2,R1,R2>`	`bimap(java.util.function.Function<? super LT3,? extends R1> fn1, java.util.function.Function<? super RT,? extends R2> fn2)` Transform this BiTransformable, changing two value types at once.
`boolean`	`complete(ORG done)`
`boolean`	`completeExceptionally(java.lang.Throwable error)`
`Maybe<RT>`	`filter(java.util.function.Predicate<? super RT> test)` Filter this Either4 resulting in a Maybe#none if it is not a Right instance or if the predicate does not hold.
`<RT1> LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT1>`	`flatMap(java.util.function.Function<? super RT,? extends LazyEither5<java.lang.Throwable,LT1,LT2,LT3,? extends RT1>> mapper)` Flattening transformation on this Either4.
`<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> left1, java.util.function.Function<? super LT1,? extends R> left2, java.util.function.Function<? super LT2,? extends R> left3, java.util.function.Function<? super LT3,? extends R> left4, java.util.function.Function<? super RT,? extends R> right)`
`Option<RT>`	`get()`
`boolean`	`isDone()`
`boolean`	`isFailed()`
`boolean`	`isLeft1()`
`boolean`	`isLeft2()`
`boolean`	`isLeft3()`
`boolean`	`isLeft4()`
`boolean`	`isRight()`
`<R> LazyEither5<java.lang.Throwable,LT1,LT2,LT3,R>`	`map(java.util.function.Function<? super RT,? extends R> fn)` Transform this functor using the supplied transformation function
`void`	`subscribe(org.reactivestreams.Subscriber<? super RT> sub)`
`LazyEither5<RT,LT1,LT2,LT3,java.lang.Throwable>`	`swap1()`
`LazyEither5<java.lang.Throwable,RT,LT2,LT3,LT1>`	`swap2()`
`LazyEither5<java.lang.Throwable,LT1,RT,LT3,LT2>`	`swap3()`
`LazyEither5<java.lang.Throwable,LT1,LT2,RT,LT3>`	`swap4()`
`<T> LazyEither5<java.lang.Throwable,LT1,LT2,LT3,T>`	`unit(T unit)`

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

Methods inherited from interface cyclops.control.LazyEither5
accumulate, always, applyAny, bipeek, coflatMap, consumeAny, either4, either5, filter, filterNot, foEval, foldAny, forEach2, forEach3, forEach4, fromFuture, fromIterable, fromLazy, fromPublisher, later, left1, left1Eval, left2, left2Eval, left3, left3Eval, left4, left4Eval, nest, notNull, ofType, peek, right, rightEval, sequence, sequence, toEither, toIor, toTrampoline, traverse, traverse, visitAny, visitAny, zip

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, isPresent, iterate, iterator, mkString, nonEmptyList, nonEmptyListGet, orElse, orElseGet, print, print, printErr, printOut, stream, toEither, toLazyEither, toLeft, toMaybe, toOption, toOptional, toRight, toTry, toTry, toTry

Methods inherited from interface java.lang.Iterable
spliterator

- Field Detail
  - complete
```
public final java.util.concurrent.CompletableFuture<ORG> complete
```
  - either
```
public final LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT> either
```
- Constructor Detail
  - CompletableEither5
```
public CompletableEither5()
```
- Method Detail
  - 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>
  - get
```
public Option<RT> get()
```
    Specified by:
    
    get in interface LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>
  - fold
```
public <R> R fold(java.util.function.Function<? super java.lang.Throwable,? extends R> left1,
                  java.util.function.Function<? super LT1,? extends R> left2,
                  java.util.function.Function<? super LT2,? extends R> left3,
                  java.util.function.Function<? super LT3,? extends R> left4,
                  java.util.function.Function<? super RT,? extends R> right)
```
    Specified by:
    
    fold in interface Sealed5<java.lang.Throwable,LT1,LT2,LT3,RT>
    
    Specified by:
    
    fold in interface LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>
  - filter
```
public Maybe<RT> filter(java.util.function.Predicate<? super RT> test)
```
    Description copied from interface: LazyEither5
    
    Filter this Either4 resulting in a Maybe#none if it is not a Right instance or if the predicate does not hold. Otherwise results in a Maybe containing the current value
    
    Specified by:
    
    filter in interface Filters<RT>
    
    Specified by:
    
    filter in interface LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>
    
    Parameters:
    
    test - Predicate to applyHKT to filter this Either4
    
    Returns:
    
    Maybe containing the current value if this is a Right instance and the predicate holds, otherwise Maybe#none
  - flatMap
```
public <RT1> LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT1> flatMap(java.util.function.Function<? super RT,? extends LazyEither5<java.lang.Throwable,LT1,LT2,LT3,? extends RT1>> mapper)
```
    Description copied from interface: LazyEither5
    
    Flattening transformation on this Either4. Contains an internal trampoline so will convert tail-recursive calls to iteration.
    
    Specified by:
    
    flatMap in interface LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>
    
    Parameters:
    
    mapper - Mapping function
    
    Returns:
    
    Mapped Either4
  - swap4
```
public LazyEither5<java.lang.Throwable,LT1,LT2,RT,LT3> swap4()
```
    Specified by:
    
    swap4 in interface LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>
    
    Returns:
    
    Swap the fourth and the right types
  - swap3
```
public LazyEither5<java.lang.Throwable,LT1,RT,LT3,LT2> swap3()
```
    Specified by:
    
    swap3 in interface LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>
    
    Returns:
    
    Swap the third and the right types
  - swap2
```
public LazyEither5<java.lang.Throwable,RT,LT2,LT3,LT1> swap2()
```
    Specified by:
    
    swap2 in interface LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>
    
    Returns:
    
    Swap the second and the right types
  - swap1
```
public LazyEither5<RT,LT1,LT2,LT3,java.lang.Throwable> swap1()
```
    Specified by:
    
    swap1 in interface LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>
    
    Returns:
    
    Swap the right and left types
  - isRight
```
public boolean isRight()
```
    Specified by:
    
    isRight in interface LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>
    
    Returns:
    
    True if this lazy contains the right type
  - isLeft1
```
public boolean isLeft1()
```
    Specified by:
    
    isLeft1 in interface LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>
    
    Returns:
    
    True if this lazy contains the left1 type
  - isLeft2
```
public boolean isLeft2()
```
    Specified by:
    
    isLeft2 in interface LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>
    
    Returns:
    
    True if this lazy contains the left2 type
  - isLeft3
```
public boolean isLeft3()
```
    Specified by:
    
    isLeft3 in interface LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>
    
    Returns:
    
    True if this lazy contains the left3 type
  - isLeft4
```
public boolean isLeft4()
```
    Specified by:
    
    isLeft4 in interface LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>
    
    Returns:
    
    True if this lazy contains the left4 type
  - bimap
```
public <R1,R2> LazyEither5<java.lang.Throwable,LT1,LT2,R1,R2> bimap(java.util.function.Function<? super LT3,? extends R1> fn1,
                                                                    java.util.function.Function<? super RT,? extends R2> fn2)
```
    Description copied from interface: BiTransformable
    Transform this BiTransformable, changing two value types at once.
```
 
     MapX<String,Integer> map = MapXs.of("hello",2);
     MapX<String,Integer> transformedMap = map.bimap(s->s+" world",i->i*4);
     //["hello world",8]
 
 
```
    Specified by:
    
    bimap in interface BiTransformable<LT3,RT>
    
    Specified by:
    
    bimap in interface LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>
    
    Parameters:
    
    fn1 - transformation function for the first type
    
    fn2 - transformation function for the second type
    
    Returns:
    
    New BiTransformable containing transformed data
  - map
```
public <R> LazyEither5<java.lang.Throwable,LT1,LT2,LT3,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 LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>
    
    Parameters:
    
    fn - Transformation function
    
    Returns:
    
    Transformed Transformable
  - unit
```
public <T> LazyEither5<java.lang.Throwable,LT1,LT2,LT3,T> unit(T unit)
```
    Specified by:
    
    unit in interface Unit<RT>
    
    Specified by:
    
    unit in interface LazyEither5<java.lang.Throwable,LT1,LT2,LT3,RT>
  - 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>
  - subscribe
```
public void subscribe(org.reactivestreams.Subscriber<? super RT> sub)
```
    Specified by:
    
    subscribe in interface Value<RT>
    
    Specified by:
    
    subscribe in interface org.reactivestreams.Publisher<RT>

Class LazyEither5.CompletableEither5<ORG,LT1,LT2,LT3,RT>

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface cyclops.control.LazyEither5

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

Field Detail

complete

either

Constructor Detail

CompletableEither5

Method Detail

isFailed

isDone

complete

completeExceptionally

get

fold

filter

flatMap

swap4

swap3

swap2

swap1

isRight

isLeft1

isLeft2

isLeft3

isLeft4

bimap

map

unit

fold

subscribe