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

java.lang.Object
- cyclops.control.lazy.Either.Left<ST,PT>

All Implemented Interfaces:

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

Enclosing interface:

Either<LT,RT>
```
public static class Either.Left<ST,PT>
extends java.lang.Object
implements Either<ST,PT>
```

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>

Constructor Summary

Constructors
Constructor and Description

Left()

Constructors
Constructor and Description
`Left()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T2,R> Either<ST,R>`	`combine(Value<? extends T2> app, java.util.function.BiFunction<? super PT,? super T2,? extends R> fn)` Lazily combine this ApplicativeFunctor with the supplied value via the supplied BiFunction Example
`boolean`	`equals(java.lang.Object obj)`
`Either<ST,PT>`	`filter(java.util.function.Predicate<? super PT> test)` Keep only elements for which the supplied predicates hold e.g.
`<RT1> Either<ST,RT1>`	`flatMap(java.util.function.Function<? super PT,? extends MonadicValue<? extends RT1>> mapper)` A flattening transformation operation (@see `Optional.flatMap(Function)`
`PT`	`get()`
`int`	`hashCode()`
`boolean`	`isLeft()`
`boolean`	`isRight()`
`<R> Either<ST,R>`	`map(java.util.function.Function<? super PT,? extends R> fn)` Transform this functor using the supplied transformation function
`java.lang.String`	`mkString()` Returns the class name and the name of the subclass, if there is any value, the value is showed between square brackets.
`Either<ST,PT>`	`peek(java.util.function.Consumer<? super PT> action)` Peek at the current value of this Transformable, without transforming it
`void`	`peek(java.util.function.Consumer<? super ST> stAction, java.util.function.Consumer<? super PT> ptAction)`
`<LT1> Either<LT1,PT>`	`secondaryFlatMap(java.util.function.Function<? super ST,? extends Xor<LT1,PT>> mapper)` Perform a flatMap operation on the Left type
`ST`	`secondaryGet()`
`<R> Either<R,PT>`	`secondaryMap(java.util.function.Function<? super ST,? extends R> fn)` Always map the Left type of this Either if it is present using the provided transformation function
`Either<ST,PT>`	`secondaryPeek(java.util.function.Consumer<? super ST> action)` Peek at the Left type value if present
`java.util.Optional<ST>`	`secondaryToOptional()`
`Either<ST,PT>`	`secondaryToPrimayFlatMap(java.util.function.Function<? super ST,? extends Xor<ST,PT>> fn)` A flatMap operation that keeps the Left and Right types the same
`Either<ST,PT>`	`secondaryToPrimayMap(java.util.function.Function<? super ST,? extends PT> fn)` If this Either contains the Left type, map it's value so that it contains the Right type
`ReactiveSeq<ST>`	`secondaryToStream()`
`Value<ST>`	`secondaryValue()`
`Either<PT,ST>`	`swap()` Swap types so operations directly affect the current (pre-swap) Left type
`Ior<ST,PT>`	`toIor()` Return an Ior that can be this object or a Ior.primary or Ior.secondary
`Maybe<PT>`	`toMaybe()`
`java.util.Optional<PT>`	`toOptional()`
`java.lang.String`	`toString()`
`<R> R`	`visit(java.util.function.Function<? super ST,? extends R> secondary, java.util.function.Function<? super PT,? extends R> primary)` Visitor pattern for this Ior.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, 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, 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, newSubscriber, of, stream, subscribe, test, toEither, toEval, toEvalAlways, toEvalLater, toEvalNow, toLeft, 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

- Constructor Detail
  - Left
```
public Left()
```
- Method Detail
  - isLeft
```
public boolean isLeft()
```
    Specified by:
    
    isLeft in interface Either<ST,PT>
    
    Returns:
    
    True if this is a secondary Either
  - isRight
```
public boolean isRight()
```
    Specified by:
    
    isRight in interface Either<ST,PT>
    
    Returns:
    
    True if this is a primary Either
  - secondaryToPrimayMap
```
public Either<ST,PT> secondaryToPrimayMap(java.util.function.Function<? super ST,? extends PT> 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<ST,PT>
    
    Specified by:
    
    secondaryToPrimayMap in interface Xor<ST,PT>
    
    Parameters:
    
    fn - Function to map secondary type to primary
    
    Returns:
    
    Either with secondary type mapped to primary
  - secondaryMap
```
public <R> Either<R,PT> secondaryMap(java.util.function.Function<? super ST,? 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<ST,PT>
    
    Specified by:
    
    secondaryMap in interface Xor<ST,PT>
    
    Parameters:
    
    fn - Transformation function for Left types
    
    Returns:
    
    Either with Left type transformed
  - map
```
public <R> Either<ST,R> map(java.util.function.Function<? super PT,? 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<PT>
    
    Specified by:
    
    map in interface MonadicValue<PT>
    
    Specified by:
    
    map in interface Either<ST,PT>
    
    Specified by:
    
    map in interface Xor<ST,PT>
    
    Parameters:
    
    fn - Transformation function
    
    Returns:
    
    Transformed Transformable
  - secondaryPeek
```
public Either<ST,PT> secondaryPeek(java.util.function.Consumer<? super ST> action)
```
    Description copied from interface: Either
    
    Peek at the Left type value if present
    
    Specified by:
    
    secondaryPeek in interface Either<ST,PT>
    
    Specified by:
    
    secondaryPeek in interface Xor<ST,PT>
    
    Parameters:
    
    action - Consumer to peek at the Left type value
    
    Returns:
    
    Either with the same values as before
  - peek
```
public Either<ST,PT> peek(java.util.function.Consumer<? super PT> 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<PT>
    
    Specified by:
    
    peek in interface Either<ST,PT>
    
    Specified by:
    
    peek in interface Xor<ST,PT>
    
    Parameters:
    
    action - Consumer that recieves each element from this Transformable
    
    Returns:
    
    Transformable that will peek at each value
  - filter
```
public Either<ST,PT> filter(java.util.function.Predicate<? super PT> 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<PT>
    
    Specified by:
    
    filter in interface MonadicValue<PT>
    
    Specified by:
    
    filter in interface Either<ST,PT>
    
    Specified by:
    
    filter in interface Xor<ST,PT>
    
    Parameters:
    
    test - to filter elements by, retaining matches
    
    Returns:
    
    Filters with elements removed where the predicate does not hold
  - swap
```
public Either<PT,ST> 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<ST,PT>
    
    Specified by:
    
    swap in interface Xor<ST,PT>
    
    Returns:
    
    Swap the primary and secondary types, allowing operations directly on what was the Left type
  - get
```
public PT get()
```
    Specified by:
    
    get in interface Convertable<PT>
    
    Specified by:
    
    get in interface Either<ST,PT>
    
    Specified by:
    
    get in interface Xor<ST,PT>
    
    Specified by:
    
    get in interface java.util.function.Supplier<PT>
    
    Returns:
    
    Contained value, maybe null
  - secondaryGet
```
public ST secondaryGet()
```
    Specified by:
    
    secondaryGet in interface Either<ST,PT>
    
    Specified by:
    
    secondaryGet in interface Xor<ST,PT>
    
    Returns:
    
    The Left Value if present, otherwise null
  - secondaryToOptional
```
public java.util.Optional<ST> secondaryToOptional()
```
    Specified by:
    
    secondaryToOptional in interface Either<ST,PT>
    
    Specified by:
    
    secondaryToOptional in interface Xor<ST,PT>
    
    Returns:
    
    The Left value wrapped in an Optional if present, otherwise an zero Optional
  - secondaryToStream
```
public ReactiveSeq<ST> secondaryToStream()
```
    Specified by:
    
    secondaryToStream in interface Either<ST,PT>
    
    Specified by:
    
    secondaryToStream in interface Xor<ST,PT>
    
    Returns:
    
    A Stream containing the secondary value if present, otherwise an zero Stream
  - flatMap
```
public <RT1> Either<ST,RT1> flatMap(java.util.function.Function<? super PT,? 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<PT>
    
    Specified by:
    
    flatMap in interface Either<ST,PT>
    
    Specified by:
    
    flatMap in interface Xor<ST,PT>
    
    Parameters:
    
    mapper - transformation function
    
    Returns:
    
    MonadicValue
  - secondaryFlatMap
```
public <LT1> Either<LT1,PT> secondaryFlatMap(java.util.function.Function<? super ST,? extends Xor<LT1,PT>> mapper)
```
    Description copied from interface: Either
    
    Perform a flatMap operation on the Left type
    
    Specified by:
    
    secondaryFlatMap in interface Either<ST,PT>
    
    Specified by:
    
    secondaryFlatMap in interface Xor<ST,PT>
    
    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
  - secondaryToPrimayFlatMap
```
public Either<ST,PT> secondaryToPrimayFlatMap(java.util.function.Function<? super ST,? extends Xor<ST,PT>> fn)
```
    Description copied from interface: Either
    
    A flatMap operation that keeps the Left and Right types the same
    
    Specified by:
    
    secondaryToPrimayFlatMap in interface Either<ST,PT>
    
    Specified by:
    
    secondaryToPrimayFlatMap in interface Xor<ST,PT>
    
    Parameters:
    
    fn - Transformation function
    
    Returns:
    
    Either
  - peek
```
public void peek(java.util.function.Consumer<? super ST> stAction,
                 java.util.function.Consumer<? super PT> ptAction)
```
    Specified by:
    
    peek in interface Either<ST,PT>
    
    Specified by:
    
    peek in interface Xor<ST,PT>
  - visit
```
public <R> R visit(java.util.function.Function<? super ST,? extends R> secondary,
                   java.util.function.Function<? super PT,? 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<ST,PT>
    
    Specified by:
    
    visit in interface Xor<ST,PT>
    
    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
  - toMaybe
```
public Maybe<PT> toMaybe()
```
    Specified by:
    
    toMaybe in interface Value<PT>
  - toOptional
```
public java.util.Optional<PT> toOptional()
```
    Specified by:
    
    toOptional in interface Convertable<PT>
    
    Specified by:
    
    toOptional in interface Either<ST,PT>
    
    Specified by:
    
    toOptional in interface Xor<ST,PT>
    
    Returns:
    
    Optional that wraps contained value, Optional.zero if value is null
  - secondaryValue
```
public Value<ST> secondaryValue()
```
    Specified by:
    
    secondaryValue in interface Either<ST,PT>
    
    Specified by:
    
    secondaryValue in interface Xor<ST,PT>
    
    Returns:
    
    A Value containing the secondary Value if present
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - mkString
```
public java.lang.String mkString()
```
    Description copied from interface: Value
    
    Returns the class name and the name of the subclass, if there is any value, the value is showed between square brackets.
    
    Specified by:
    
    mkString in interface Value<PT>
    
    Returns:
    
    String
  - toIor
```
public Ior<ST,PT> 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<PT>
    
    Specified by:
    
    toIor in interface Either<ST,PT>
    
    Specified by:
    
    toIor in interface Xor<ST,PT>
    
    Returns:
    
    new Ior
  - combine
```
public <T2,R> Either<ST,R> combine(Value<? extends T2> app,
                                   java.util.function.BiFunction<? super PT,? 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<PT>
    
    Specified by:
    
    combine in interface Either<ST,PT>
    
    Specified by:
    
    combine in interface Xor<ST,PT>
    
    Parameters:
    
    app - Value to combine with this one.
    
    fn - BiFunction to combine them
    
    Returns:
    
    New Applicativefunctor that represents the combined values
  - 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.Left<ST,PT>

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

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

Constructor Detail

Left

Method Detail

isLeft

isRight

secondaryToPrimayMap

secondaryMap

map

secondaryPeek

peek

filter

swap

get

secondaryGet

secondaryToOptional

secondaryToStream

flatMap

secondaryFlatMap

secondaryToPrimayFlatMap

peek

visit

toMaybe

toOptional

secondaryValue

toString

mkString

toIor

combine

hashCode

equals