Either.CompletableEither (cyclops-reactor 9.0.0-FINAL API)

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

All Implemented Interfaces:

Convert<Higher<Higher<Witness.xor,java.lang.Throwable>,RT>>, Higher<Higher<Witness.xor,java.lang.Throwable>,RT>, Higher2<Witness.xor,java.lang.Throwable,RT>, Unit<RT>, Filters<RT>, Convertable<RT>, Folds<RT>, To<Xor<java.lang.Throwable,RT>>, Visitable<RT>, BiTransformable<java.lang.Throwable,RT>, Transformable<RT>, MonadicValue<RT>, Completable<ORG>, Value<RT>, Zippable<RT>, Either<java.lang.Throwable,RT>, Xor<java.lang.Throwable,RT>, Fn0<RT>, java.lang.Iterable<RT>, java.util.function.Predicate<RT>, java.util.function.Supplier<RT>, org.reactivestreams.Publisher<RT>

Enclosing interface:

Either<LT,RT>
```
public static class Either.CompletableEither<ORG,RT>
extends java.lang.Object
implements Either<java.lang.Throwable,RT>, Completable<ORG>
```

Nested Class Summary
- Nested classes/interfaces inherited from interface cyclops.control.lazy.Either
  Either.CompletableEither<ORG,RT>, Either.Lazy<ST,PT>, Either.Left<ST,PT>, Either.Right<ST,PT>
- Nested classes/interfaces inherited from interface cyclops.control.Xor
  Xor.Instances, Xor.Primary<ST,PT>, Xor.Secondary<ST,PT>
- Nested classes/interfaces inherited from interface com.aol.cyclops2.types.Value
  Value.ValueImpl<T>
- Nested classes/interfaces inherited from interface com.aol.cyclops2.types.foldable.Convertable
  Convertable.SupplierToConvertable<T>
- Nested classes/interfaces inherited from interface cyclops.function.Fn0
  Fn0.FunctionalOperations<R>, Fn0.SupplierKind<R>
- Nested classes/interfaces inherited from interface com.aol.cyclops2.types.reactive.Completable
  Completable.CompletablePublisher<T>

Field Summary

Fields
Modifier and Type Field and Description

Completable.CompletablePublisher<ORG> complete

Either<java.lang.Throwable,RT> either

Fields
Modifier and Type	Field and Description
`Completable.CompletablePublisher<ORG>`	`complete`
`Either<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
`<T2,R> Either<java.lang.Throwable,R>`	`combine(Value<? extends T2> app, java.util.function.BiFunction<? super RT,? super T2,? extends R> fn)` Lazily combine this ApplicativeFunctor with the supplied value via the supplied BiFunction Example
`boolean`	`complete(ORG done)`
`boolean`	`completeExceptionally(java.lang.Throwable error)`
`boolean`	`equals(java.lang.Object obj)`
`Either<java.lang.Throwable,RT>`	`filter(java.util.function.Predicate<? super RT> test)` Keep only elements for which the supplied predicates hold e.g.
`<RT1> Either<java.lang.Throwable,RT1>`	`flatMap(java.util.function.Function<? super RT,? extends MonadicValue<? extends RT1>> mapper)` A flattening transformation operation (@see `Optional.flatMap(Function)`
`RT`	`get()`
`int`	`hashCode()`
`boolean`	`isDone()`
`boolean`	`isFailed()`
`boolean`	`isLeft()`
`boolean`	`isRight()`
`<R> Either<java.lang.Throwable,R>`	`map(java.util.function.Function<? super RT,? extends R> fn)` Transform this functor using the supplied transformation function
`Either<java.lang.Throwable,RT>`	`peek(java.util.function.Consumer<? super RT> action)` Peek at the current value of this Transformable, without transforming it
`void`	`peek(java.util.function.Consumer<? super java.lang.Throwable> stAction, java.util.function.Consumer<? super RT> ptAction)`
`<LT1> Either<LT1,RT>`	`secondaryFlatMap(java.util.function.Function<? super java.lang.Throwable,? extends Xor<LT1,RT>> mapper)` Perform a flatMap operation on the Left type
`java.lang.Throwable`	`secondaryGet()`
`<R> Either<R,RT>`	`secondaryMap(java.util.function.Function<? super java.lang.Throwable,? extends R> fn)` Always map the Left type of this Either if it is present using the provided transformation function
`Either<java.lang.Throwable,RT>`	`secondaryPeek(java.util.function.Consumer<? super java.lang.Throwable> action)` Peek at the Left type value if present
`java.util.Optional<java.lang.Throwable>`	`secondaryToOptional()`
`Either<java.lang.Throwable,RT>`	`secondaryToPrimayFlatMap(java.util.function.Function<? super java.lang.Throwable,? extends Xor<java.lang.Throwable,RT>> fn)` A flatMap operation that keeps the Left and Right types the same
`Either<java.lang.Throwable,RT>`	`secondaryToPrimayMap(java.util.function.Function<? super java.lang.Throwable,? extends RT> fn)` If this Either contains the Left type, map it's value so that it contains the Right type
`ReactiveSeq<java.lang.Throwable>`	`secondaryToStream()`
`Value<java.lang.Throwable>`	`secondaryValue()`
`Either<RT,java.lang.Throwable>`	`swap()` Swap types so operations directly affect the current (pre-swap) Left type
`Ior<java.lang.Throwable,RT>`	`toIor()` Return an Ior that can be this object or a Ior.primary or Ior.secondary
`<R> R`	`visit(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.

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

Methods inherited from interface cyclops.control.lazy.Either
accumulate, anyMEither, applyAny, async, bicast, bimap, bipeek, bitrampoline, cast, coflatMap, combine, combine, combineEager, combineToList, combineToList, consumeAny, either, filterNot, flatMapI, flatMapP, flatMapS, forEach2, forEach2, forEach3, forEach3, forEach4, forEach4, fromFuture, fromIterable, fromLazy, fromMonadicValue, fromPublisher, fromXor, isPresent, isPrimary, isSecondary, left, leftEval, list, mapBoth, narrow, nest, notNull, ofType, retry, retry, right, rightEval, sequenceLeft, sequenceRight, toEitherTrampoline, toOptional, toTrampoline, toTrampoline, toTrampoline, toXor, toXor, trampoline, traverseLeft, traverseRight, unit, visitAny, visitAny, zip, zip, zip, zip3, zip3, zip4, zip4, zipP, zipP, zipS, zipS, zipWith, zipWithP, zipWithS

Methods inherited from interface cyclops.control.Xor
accumulatePrimary, accumulatePrimary, accumulatePrimary, accumulateSecondary, accumulateSecondary, accumulateSecondary, allTypeclasses, anyM, applyAny, arity, consumeAny, coproduct, kindCokleisli, kindKleisli, liftM, mapM, narrowK, narrowK2, nested, nestedEval, primary, product, secondary, sequencePrimary, sequenceSecondary, visitAny, visitAny, widen

Methods inherited from interface com.aol.cyclops2.types.foldable.To
to

Methods inherited from interface com.aol.cyclops2.types.Value
apply, generate, iterate, iterator, mkString, newSubscriber, of, stream, subscribe, test, toEither, toEval, toEvalAlways, toEvalLater, toEvalNow, toLeft, toMaybe, toMaybeEager, toRight, toTry, toTry, toTry

Methods inherited from interface com.aol.cyclops2.types.foldable.Folds
endsWith, endsWithIterable, findAny, findFirst, firstValue, foldLeft, foldLeft, foldLeft, foldLeft, foldRight, foldRight, foldRight, foldRightMapToType, get, groupBy, join, join, join, mapReduce, mapReduce, print, print, printErr, printOut, reduce, reduce, reduce, reduce, reduce, reduce, reduce, schedule, scheduleFixedDelay, scheduleFixedRate, single, single, singleUnsafe, startsWith, startsWithIterable, takeOne, xMatch

Methods inherited from interface com.aol.cyclops2.types.foldable.Convertable
collect, fromSupplier, orElse, orElseGet, orElseThrow, toCompletableFuture, toCompletableFutureAsync, toFuture, toFutureAsync, toStream, visit

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface cyclops.function.Fn0
andThen, fnTo, functionOps, future, lift, lift, liftF, liftOpt, liftTry, memoize, memoize, memoizeAsync, memoizeAsync, run, suspend, λ, λv

Methods inherited from interface java.util.function.Predicate
and, isEqual, negate, or

Methods inherited from interface com.aol.cyclops2.hkt.Higher
applyHKT_, applyHKT, applyHKT

Methods inherited from interface com.aol.cyclops2.hkt.Convert
convert

- Field Detail
  - complete
```
public final Completable.CompletablePublisher<ORG> complete
```
  - either
```
public final Either<java.lang.Throwable,RT> either
```
- Constructor Detail
  - CompletableEither
```
public CompletableEither()
```
- 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>
  - filter
```
public Either<java.lang.Throwable,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 MonadicValue<RT>
    
    Specified by:
    
    filter in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    filter in interface Xor<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> Either<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 MonadicValue<RT>
    
    Specified by:
    
    map in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    map in interface Xor<java.lang.Throwable,RT>
    
    Parameters:
    
    fn - Transformation function
    
    Returns:
    
    Transformed Transformable
  - peek
```
public Either<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 Xor<java.lang.Throwable,RT>
    
    Parameters:
    
    action - Consumer that recieves each element from this Transformable
    
    Returns:
    
    Transformable that will peek at each value
  - swap
```
public Either<RT,java.lang.Throwable> swap()
```
    Description copied from interface: Either
    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 Xor<java.lang.Throwable,RT>
    
    Returns:
    
    Swap the primary and secondary types, allowing operations directly on what was the Left type
  - toIor
```
public Ior<java.lang.Throwable,RT> toIor()
```
    Description copied from interface: Value
    
    Return an Ior that can be this object or a Ior.primary or Ior.secondary
    
    Specified by:
    
    toIor in interface Value<RT>
    
    Specified by:
    
    toIor in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    toIor in interface Xor<java.lang.Throwable,RT>
    
    Returns:
    
    new Ior
  - get
```
public RT get()
```
    Specified by:
    
    get in interface Convertable<RT>
    
    Specified by:
    
    get in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    get in interface Xor<java.lang.Throwable,RT>
    
    Specified by:
    
    get in interface java.util.function.Supplier<RT>
    
    Returns:
    
    Contained value, maybe null
  - secondaryValue
```
public Value<java.lang.Throwable> secondaryValue()
```
    Specified by:
    
    secondaryValue in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    secondaryValue in interface Xor<java.lang.Throwable,RT>
    
    Returns:
    
    A Value containing the secondary Value if present
  - secondaryGet
```
public java.lang.Throwable secondaryGet()
```
    Specified by:
    
    secondaryGet in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    secondaryGet in interface Xor<java.lang.Throwable,RT>
    
    Returns:
    
    The Left Value if present, otherwise null
  - secondaryToOptional
```
public java.util.Optional<java.lang.Throwable> secondaryToOptional()
```
    Specified by:
    
    secondaryToOptional in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    secondaryToOptional in interface Xor<java.lang.Throwable,RT>
    
    Returns:
    
    The Left value wrapped in an Optional if present, otherwise an zero Optional
  - secondaryToStream
```
public ReactiveSeq<java.lang.Throwable> secondaryToStream()
```
    Specified by:
    
    secondaryToStream in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    secondaryToStream in interface Xor<java.lang.Throwable,RT>
    
    Returns:
    
    A Stream containing the secondary value if present, otherwise an zero Stream
  - flatMap
```
public <RT1> Either<java.lang.Throwable,RT1> flatMap(java.util.function.Function<? super RT,? extends MonadicValue<? extends RT1>> mapper)
```
    Description copied from interface: MonadicValue
    A flattening transformation operation (@see Optional.flatMap(Function)
```
  
   Eval.now(1).map(i->i+2).flatMap(i->Eval.later(()->i*3);
   //Eval[9]
 
 
```
    Specified by:
    
    flatMap in interface MonadicValue<RT>
    
    Specified by:
    
    flatMap in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    flatMap in interface Xor<java.lang.Throwable,RT>
    
    Parameters:
    
    mapper - transformation function
    
    Returns:
    
    MonadicValue
  - isRight
```
public boolean isRight()
```
    Specified by:
    
    isRight in interface Either<java.lang.Throwable,RT>
    
    Returns:
    
    True if this is a primary Either
  - isLeft
```
public boolean isLeft()
```
    Specified by:
    
    isLeft in interface Either<java.lang.Throwable,RT>
    
    Returns:
    
    True if this is a secondary Either
  - combine
```
public <T2,R> Either<java.lang.Throwable,R> combine(Value<? extends T2> app,
                                                    java.util.function.BiFunction<? super RT,? super T2,? extends R> fn)
```
    Description copied from interface: MonadicValue
    Lazily combine this ApplicativeFunctor with the supplied value via the supplied BiFunction Example
```
 
   Maybe<Integer> some = Maybe.just(10);
   just.combine(Eval.now(20), this::add);
   //Some[30]

   Maybe<Integer> none = Maybe.none();
   none.combine(Eval.now(20), this::add);
   //None

 
 
```
    Specified by:
    
    combine in interface MonadicValue<RT>
    
    Specified by:
    
    combine in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    combine in interface Xor<java.lang.Throwable,RT>
    
    Parameters:
    
    app - Value to combine with this one.
    
    fn - BiFunction to combine them
    
    Returns:
    
    New Applicativefunctor that represents the combined values
  - peek
```
public void peek(java.util.function.Consumer<? super java.lang.Throwable> stAction,
                 java.util.function.Consumer<? super RT> ptAction)
```
    Specified by:
    
    peek in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    peek in interface Xor<java.lang.Throwable,RT>
  - secondaryToPrimayFlatMap
```
public Either<java.lang.Throwable,RT> secondaryToPrimayFlatMap(java.util.function.Function<? super java.lang.Throwable,? extends Xor<java.lang.Throwable,RT>> fn)
```
    Description copied from interface: Either
    
    A flatMap operation that keeps the Left and Right types the same
    
    Specified by:
    
    secondaryToPrimayFlatMap in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    secondaryToPrimayFlatMap in interface Xor<java.lang.Throwable,RT>
    
    Parameters:
    
    fn - Transformation function
    
    Returns:
    
    Either
  - secondaryFlatMap
```
public <LT1> Either<LT1,RT> secondaryFlatMap(java.util.function.Function<? super java.lang.Throwable,? extends Xor<LT1,RT>> mapper)
```
    Description copied from interface: Either
    
    Perform a flatMap operation on the Left type
    
    Specified by:
    
    secondaryFlatMap in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    secondaryFlatMap in interface Xor<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
  - visit
```
public <R> R visit(java.util.function.Function<? super java.lang.Throwable,? extends R> secondary,
                   java.util.function.Function<? super RT,? extends R> primary)
```
    Description copied from interface: Either
    Visitor pattern for this Ior. Execute the secondary function if this Either contains an element of the secondary type Execute the primary function if this Either contains an element of the primary type
```
 
  Either.right(10)
     .visit(secondary->"no", primary->"yes")
  //Either["yes"]

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



 
 
```
    Specified by:
    
    visit in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    visit in interface Xor<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
  - secondaryPeek
```
public Either<java.lang.Throwable,RT> secondaryPeek(java.util.function.Consumer<? super java.lang.Throwable> action)
```
    Description copied from interface: Either
    
    Peek at the Left type value if present
    
    Specified by:
    
    secondaryPeek in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    secondaryPeek in interface Xor<java.lang.Throwable,RT>
    
    Parameters:
    
    action - Consumer to peek at the Left type value
    
    Returns:
    
    Either with the same values as before
  - secondaryMap
```
public <R> Either<R,RT> secondaryMap(java.util.function.Function<? super java.lang.Throwable,? extends R> fn)
```
    Description copied from interface: Either
    
    Always map the Left type of this Either if it is present using the provided transformation function
    
    Specified by:
    
    secondaryMap in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    secondaryMap in interface Xor<java.lang.Throwable,RT>
    
    Parameters:
    
    fn - Transformation function for Left types
    
    Returns:
    
    Either with Left type transformed
  - secondaryToPrimayMap
```
public Either<java.lang.Throwable,RT> secondaryToPrimayMap(java.util.function.Function<? super java.lang.Throwable,? extends RT> fn)
```
    Description copied from interface: Either
    
    If this Either contains the Left type, map it's value so that it contains the Right type
    
    Specified by:
    
    secondaryToPrimayMap in interface Either<java.lang.Throwable,RT>
    
    Specified by:
    
    secondaryToPrimayMap in interface Xor<java.lang.Throwable,RT>
    
    Parameters:
    
    fn - Function to map secondary type to primary
    
    Returns:
    
    Either with secondary type mapped to primary
  - 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

Class Either.CompletableEither<ORG,RT>

Nested Class Summary

Nested classes/interfaces inherited from interface cyclops.control.lazy.Either

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

Nested classes/interfaces inherited from interface com.aol.cyclops2.types.Value

Nested classes/interfaces inherited from interface com.aol.cyclops2.types.foldable.Convertable

Nested classes/interfaces inherited from interface cyclops.function.Fn0

Nested classes/interfaces inherited from interface com.aol.cyclops2.types.reactive.Completable

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface cyclops.control.lazy.Either

Methods inherited from interface cyclops.control.Xor

Methods inherited from interface com.aol.cyclops2.types.foldable.To

Methods inherited from interface com.aol.cyclops2.types.Value

Methods inherited from interface com.aol.cyclops2.types.foldable.Folds

Methods inherited from interface com.aol.cyclops2.types.foldable.Convertable

Methods inherited from interface java.lang.Iterable

Methods inherited from interface cyclops.function.Fn0

Methods inherited from interface java.util.function.Predicate

Methods inherited from interface com.aol.cyclops2.hkt.Higher

Methods inherited from interface com.aol.cyclops2.hkt.Convert

Field Detail

complete

either

Constructor Detail

CompletableEither

Method Detail

isFailed

isDone

complete

completeExceptionally

filter

map

peek

swap

toIor

get

secondaryValue

secondaryGet

secondaryToOptional

secondaryToStream

flatMap

isRight

isLeft

combine

peek

secondaryToPrimayFlatMap

secondaryFlatMap

visit

secondaryPeek

secondaryMap

secondaryToPrimayMap

hashCode

equals