MonadicValue (cyclops-reactor 9.0.0-FINAL API)

Type Parameters:

T - Data type of element stored inside this Monad

All Superinterfaces:

Convertable<T>, Filters<T>, Fn0<T>, Folds<T>, java.lang.Iterable<T>, java.util.function.Predicate<T>, org.reactivestreams.Publisher<T>, java.util.function.Supplier<T>, Transformable<T>, Unit<T>, Value<T>, Visitable<T>, Zippable<T>

All Known Subinterfaces:

AnyMValue<W,T>, AnyMValue2<W,T2,T>, Either<LT,RT>, Either3<LT1,LT2,RT>, Either4<LT1,LT2,LT3,RT>, Either5<LT1,LT2,LT3,LT4,RT>, Eval<T>, Ior<ST,PT>, Maybe<T>, Xor<ST,PT>

All Known Implementing Classes:

AnyMValue2Impl, AnyMValueImpl, Either.CompletableEither, Either.Lazy, Either.Left, Either.Right, Either3.CompletableEither3, Either3.Lazy, Either3.Left1, Either3.Left2, Either3.Right, Either4.CompletableEither4, Either4.Lazy, Either4.Left1, Either4.Left2, Either4.Left3, Either4.Right, Either5.CompletableEither5, Either5.Lazy, Either5.Left1, Either5.Left2, Either5.Left3, Either5.Left4, Either5.Right, Eval.CompletableEval, Eval.Module.Always, Eval.Module.FutureAlways, Eval.Module.Later, Future, Ior.Both, Ior.Primary, Ior.Secondary, Maybe.CompletableMaybe, Maybe.Just, Maybe.Lazy, Maybe.Nothing, Try, Xor.Primary, Xor.Secondary
```
public interface MonadicValue<T>
extends Value<T>, Unit<T>, Transformable<T>, Filters<T>, Zippable<T>
```
A type that represents a Monad that wraps a singleUnsafe value

Nested Class Summary
- 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.Instances, Fn0.SupplierKind<R>

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default int`	`arity()`
`default <R> MonadicValue<R>`	`coflatMap(java.util.function.Function<? super MonadicValue<T>,R> mapper)` Perform a coflatMap operation.
`default <T2,R> MonadicValue<R>`	`combine(Value<? extends T2> app, java.util.function.BiFunction<? super T,? super T2,? extends R> fn)` Lazily combine this ApplicativeFunctor with the supplied value via the supplied BiFunction Example
`default MonadicValue<T>`	`combineEager(Monoid<T> monoid, MonadicValue<? extends T> v2)` Eagerly combine two MonadicValues using the supplied monoid (@see ApplicativeFunctor for type appropraite i.e.
`MonadicValue<T>`	`filter(java.util.function.Predicate<? super T> predicate)` Keep only elements for which the supplied predicates hold e.g.
`<R> MonadicValue<R>`	`flatMap(java.util.function.Function<? super T,? extends MonadicValue<? extends R>> mapper)` A flattening transformation operation (@see `Optional.flatMap(Function)`
`default <R> MonadicValue<R>`	`flatMapI(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends R>> mapper)` A flattening transformation operation that takes the first value from the returned Iterable.
`default <R> MonadicValue<R>`	`flatMapP(java.util.function.Function<? super T,? extends org.reactivestreams.Publisher<? extends R>> mapper)` A flattening transformation operation that takes the first value from the returned Publisher.
`default <R> MonadicValue<R>`	`flatMapS(java.util.function.Function<? super T,? extends java.util.stream.Stream<? extends R>> mapper)`
`default <R1,R> MonadicValue<R>`	`forEach2(java.util.function.Function<? super T,? extends MonadicValue<R1>> value1, java.util.function.BiFunction<? super T,? super R1,? extends R> yieldingFunction)` Perform a two level nested internal iteration over this MonadicValue and the supplied MonadicValue
`default <R1,R> MonadicValue<R>`	`forEach2(java.util.function.Function<? super T,? extends MonadicValue<R1>> value1, java.util.function.BiFunction<? super T,? super R1,java.lang.Boolean> filterFunction, java.util.function.BiFunction<? super T,? super R1,? extends R> yieldingFunction)` Perform a two level nested internal iteration over this MonadicValue and the supplied reactiveStream
`default <T2,R1,R2,R> MonadicValue<R>`	`forEach3(java.util.function.Function<? super T,? extends MonadicValue<R1>> value1, java.util.function.BiFunction<? super T,? super R1,? extends MonadicValue<R2>> value2, Fn3<? super T,? super R1,? super R2,? extends R> yieldingFunction)` Perform a three level nested internal iteration over this MonadicValue and the supplied MonadicValues
`default <T2,R1,R2,R> MonadicValue<R>`	`forEach3(java.util.function.Function<? super T,? extends MonadicValue<R1>> value1, java.util.function.BiFunction<? super T,? super R1,? extends MonadicValue<R2>> value2, Fn3<? super T,? super R1,? super R2,java.lang.Boolean> filterFunction, Fn3<? super T,? super R1,? super R2,? extends R> yieldingFunction)` Perform a three level nested internal iteration over this MonadicValue and the supplied MonadicValues
`default <T2,R1,R2,R3,R> MonadicValue<R>`	`forEach4(java.util.function.Function<? super T,? extends MonadicValue<R1>> value1, java.util.function.BiFunction<? super T,? super R1,? extends MonadicValue<R2>> value2, Fn3<? super T,? super R1,? super R2,? extends MonadicValue<R3>> value3, Fn4<? super T,? super R1,? super R2,? super R3,? extends R> yieldingFunction)` Perform a four level nested internal iteration over this MonadicValue and the supplied MonadicValues
`default <T2,R1,R2,R3,R> MonadicValue<R>`	`forEach4(java.util.function.Function<? super T,? extends MonadicValue<R1>> value1, java.util.function.BiFunction<? super T,? super R1,? extends MonadicValue<R2>> value2, Fn3<? super T,? super R1,? super R2,? extends MonadicValue<R3>> value3, Fn4<? super T,? super R1,? super R2,? super R3,java.lang.Boolean> filterFunction, Fn4<? super T,? super R1,? super R2,? super R3,? extends R> yieldingFunction)` Perform a four level nested internal iteration over this MonadicValue and the supplied MonadicValues `Maybe.of(3) .forEach4(a->Maybe.just(a+10), (a,b)->Maybe.just(a+b), (a,b,c)->Maybe.none(), (a,b,c,d)->a+b+c<100, (a,b,c,d)->a+b+c+d); //Maybe.none`
`<R> MonadicValue<R>`	`map(java.util.function.Function<? super T,? extends R> fn)` Transform this functor using the supplied transformation function
`default MonadicValue<MonadicValue<T>>`	`nest()` cojoin pattern.
`<T> MonadicValue<T>`	`unit(T unit)`
`default <T2,R> MonadicValue<R>`	`zip(java.lang.Iterable<? extends T2> app, java.util.function.BiFunction<? super T,? super T2,? extends R> fn)` Zip (combine) this Zippable with the supplied Iterable using the supplied combining function
`default <T2,R> MonadicValue<R>`	`zipP(org.reactivestreams.Publisher<? extends T2> app, java.util.function.BiFunction<? super T,? super T2,? extends R> fn)` Zip (combine) this Zippable with the supplied Publisher, using the supplied combining function

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

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, get, isPresent, orElse, orElseGet, orElseThrow, toCompletableFuture, toCompletableFutureAsync, toFuture, toFutureAsync, toOptional, 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.types.Filters
filterNot, notNull, ofType

Methods inherited from interface com.aol.cyclops2.types.Zippable
zip, zip, zip3, zip3, zip4, zip4, zipP, zipS, zipS, zipWith, zipWithP, zipWithS

Methods inherited from interface com.aol.cyclops2.types.functor.Transformable
cast, peek, retry, retry, trampoline

Method Detail

arity
```
default int arity()
```

filter
```
MonadicValue<T> filter(java.util.function.Predicate<? super T> predicate)
```
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<T>

Parameters:

predicate - to filter elements by, retaining matches

Returns:

Filters with elements removed where the predicate does not hold

unit
```
<T> MonadicValue<T> unit(T unit)
```
Specified by:

unit in interface Unit<T>

map
```
<R> MonadicValue<R> map(java.util.function.Function<? super T,? 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<T>

Parameters:

fn - Transformation function

Returns:

Transformed Transformable

coflatMap
```
default <R> MonadicValue<R> coflatMap(java.util.function.Function<? super MonadicValue<T>,R> mapper)
```
Perform a coflatMap operation. The mapping function accepts this MonadicValue and returns a singleUnsafe value to be wrapped inside a Monad.
```
  
   Maybe.none().coflatMap(m -> m.isPresent() ? m.get() : 10);
   //Maybe[10]
 
 
```
Parameters:

mapper - Mapping / transformation function

Returns:

MonadicValue wrapping return value from transformation function applied to the value inside this MonadicValue

nest
```
default MonadicValue<MonadicValue<T>> nest()
```
cojoin pattern. Nests this Monad inside another.

Returns:

Nested Monad

flatMap

<R> MonadicValue<R> flatMap(java.util.function.Function<? super T,? extends MonadicValue<? extends R>> mapper)

A flattening transformation operation (@see Optional.flatMap(Function)

  
   Eval.now(1).map(i->i+2).flatMap(i->Eval.later(()->i*3);
   //Eval[9]

Parameters:: mapper - transformation function
Returns:: MonadicValue

forEach4

default <T2,R1,R2,R3,R> MonadicValue<R> forEach4(java.util.function.Function<? super T,? extends MonadicValue<R1>> value1,
                                                 java.util.function.BiFunction<? super T,? super R1,? extends MonadicValue<R2>> value2,
                                                 Fn3<? super T,? super R1,? super R2,? extends MonadicValue<R3>> value3,
                                                 Fn4<? super T,? super R1,? super R2,? super R3,? extends R> yieldingFunction)

Perform a four level nested internal iteration over this MonadicValue and the supplied MonadicValues

  
  Maybe.of(3)
       .forEach4(a->Maybe.just(a+10),
                 (a,b)->Maybe.just(a+b),
                 (a,b,c)->Maybe.none(),
                 (a,b,c,d)->a+b+c+d);
                                  
  
  //Maybe.none

Parameters:: value1 - Nested MonadicValue to iterate over; value2 - Nested MonadicValue to iterate over; value3 - Nested MonadicValue to iterate over; yieldingFunction - Function with pointers to the current element from both MonadicValue that generates the new elements
Returns:: MonadicValue with elements generated via nested iteration

forEach4
```
default <T2,R1,R2,R3,R> MonadicValue<R> forEach4(java.util.function.Function<? super T,? extends MonadicValue<R1>> value1,
                                                 java.util.function.BiFunction<? super T,? super R1,? extends MonadicValue<R2>> value2,
                                                 Fn3<? super T,? super R1,? super R2,? extends MonadicValue<R3>> value3,
                                                 Fn4<? super T,? super R1,? super R2,? super R3,java.lang.Boolean> filterFunction,
                                                 Fn4<? super T,? super R1,? super R2,? super R3,? extends R> yieldingFunction)
```
Perform a four level nested internal iteration over this MonadicValue and the supplied MonadicValues Maybe.of(3) .forEach4(a->Maybe.just(a+10), (a,b)->Maybe.just(a+b), (a,b,c)->Maybe.none(), (a,b,c,d)->a+b+c<100, (a,b,c,d)->a+b+c+d); //Maybe.none

Parameters:

value1 - Nested MonadicValue to iterate over

value2 - Nested MonadicValue to iterate over

value3 - Nested MonadicValue to iterate over

filterFunction - Filter to applyHKT over elements before passing non-filtered values to the yielding function

yieldingFunction - Function with pointers to the current element from both MonadicValue that generates the new elements

Returns:

MonadicValue with elements generated via nested iteration

forEach3

default <T2,R1,R2,R> MonadicValue<R> forEach3(java.util.function.Function<? super T,? extends MonadicValue<R1>> value1,
                                              java.util.function.BiFunction<? super T,? super R1,? extends MonadicValue<R2>> value2,
                                              Fn3<? super T,? super R1,? super R2,? extends R> yieldingFunction)

Perform a three level nested internal iteration over this MonadicValue and the supplied MonadicValues

  
  Maybe.of(3)
       .forEach3(a->Maybe.just(a+10),
                 (a,b)->Maybe.just(a+b),
                 (a,b,c)->a+b+c<100,
                 (a,b,c)->a+b+c);
                                  
  
  //Maybe[32]

Parameters:: value1 - Nested MonadicValue to iterate over; value2 - Nested MonadicValue to iterate over; yieldingFunction - Function with pointers to the current element from both MonadicValue that generates the new elements
Returns:: MonadicValue with elements generated via nested iteration

forEach3

default <T2,R1,R2,R> MonadicValue<R> forEach3(java.util.function.Function<? super T,? extends MonadicValue<R1>> value1,
                                              java.util.function.BiFunction<? super T,? super R1,? extends MonadicValue<R2>> value2,
                                              Fn3<? super T,? super R1,? super R2,java.lang.Boolean> filterFunction,
                                              Fn3<? super T,? super R1,? super R2,? extends R> yieldingFunction)

Perform a three level nested internal iteration over this MonadicValue and the supplied MonadicValues

  
  Maybe.of(3)
       .forEach3(a->Maybe.just(a+10),
                 (a,b)->Maybe.just(a+b),
                 (a,b,c)->a+b+c<100,
                 (a,b,c)->a+b+c);
                                  
  
  //Maybe[32]

Parameters:: value1 - Nested MonadicValue to iterate over; value2 - Nested MonadicValue to iterate over; filterFunction - Filter to applyHKT over elements before passing non-filtered values to the yielding function; yieldingFunction - Function with pointers to the current element from both MonadicValue that generates the new elements
Returns:: MonadicValue with elements generated via nested iteration

forEach2

default <R1,R> MonadicValue<R> forEach2(java.util.function.Function<? super T,? extends MonadicValue<R1>> value1,
                                        java.util.function.BiFunction<? super T,? super R1,? extends R> yieldingFunction)

Perform a two level nested internal iteration over this MonadicValue and the supplied MonadicValue

  
  Maybe.of(3)
       .forEach2(a->Maybe.none(),
                 (a,b)->a+b);
                                  
 
  //Maybe.none()

Parameters:: value1 - Nested Monadic Type to iterate over; yieldingFunction - Function with pointers to the current element from both monad types that generates the new elements
Returns:: MonadicValue with elements generated via nested iteration

forEach2

default <R1,R> MonadicValue<R> forEach2(java.util.function.Function<? super T,? extends MonadicValue<R1>> value1,
                                        java.util.function.BiFunction<? super T,? super R1,java.lang.Boolean> filterFunction,
                                        java.util.function.BiFunction<? super T,? super R1,? extends R> yieldingFunction)

Perform a two level nested internal iteration over this MonadicValue and the supplied reactiveStream

  
  Maybe.of(3)
       .forEach2(a->Maybe.none(),
                 a->b-> a<3 && b>10,
                 (a,b)->a+b);
                                  
 
  //Maybe.none()

Parameters:: monad1 - Nested monadic type to iterate over; filterFunction - Filter to applyHKT over elements before passing non-filtered values to the yielding function; yieldingFunction - Function with pointers to the current element from both Streams that generates the new elements
Returns:: MonadicValue with elements generated via nested iteration

combineEager

default MonadicValue<T> combineEager(Monoid<T> monoid,
                                     MonadicValue<? extends T> v2)

Eagerly combine two MonadicValues using the supplied monoid (@see ApplicativeFunctor for type appropraite i.e. maybe / async alternatives)

  
 
  Monoid<Integer> add = Monoid.of(1,SemigroupK.intSum);
  Maybe.of(10).combineEager(add,Maybe.none());
  //Maybe[10]
  
  Maybe.none().combineEager(add,Maybe.of(10));
  //Maybe[10]
  
  Maybe.none().combineEager(add,Maybe.none());
  //Maybe.none()
  
  Maybe.of(10).combineEager(add,Maybe.of(10));
  //Maybe[20]
  
  Monoid<Integer> firstNonNull = Monoid.of(null , SemigroupK.firstNonNull());
  Maybe.of(10).combineEager(firstNonNull,Maybe.of(10));
  //Maybe[10]

Parameters:: monoid -; v2 -
Returns:

flatMapI

default <R> MonadicValue<R> flatMapI(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends R>> mapper)

A flattening transformation operation that takes the first value from the returned Iterable.

  
   Maybe.just(1).map(i->i+2).flatMapI(i->Arrays.asList(()->i*3,20);
   //Maybe[9]

Parameters:: mapper - transformation function
Returns:: MonadicValue

flatMapS

default <R> MonadicValue<R> flatMapS(java.util.function.Function<? super T,? extends java.util.stream.Stream<? extends R>> mapper)

flatMapP

default <R> MonadicValue<R> flatMapP(java.util.function.Function<? super T,? extends org.reactivestreams.Publisher<? extends R>> mapper)

A flattening transformation operation that takes the first value from the returned Publisher.

  
   Future.ofResult(1).map(i->i+2).flatMapP(i->Flux.just(()->i*3,20);
   //Future[9]

Parameters:: mapper - transformation function
Returns:: MonadicValue

combine

default <T2,R> MonadicValue<R> combine(Value<? extends T2> app,
                                       java.util.function.BiFunction<? super T,? super T2,? extends R> fn)

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

Parameters:: app - Value to combine with this one.; fn - BiFunction to combine them
Returns:: New Applicativefunctor that represents the combined values

zip
```
default <T2,R> MonadicValue<R> zip(java.lang.Iterable<? extends T2> app,
                                   java.util.function.BiFunction<? super T,? super T2,? extends R> fn)
```
Description copied from interface: Zippable

Zip (combine) this Zippable with the supplied Iterable using the supplied combining function

Specified by:

zip in interface Zippable<T>

Parameters:

app - to zip with

fn - Zip function

Returns:

Combined zippable

zipP
```
default <T2,R> MonadicValue<R> zipP(org.reactivestreams.Publisher<? extends T2> app,
                                    java.util.function.BiFunction<? super T,? super T2,? extends R> fn)
```
Description copied from interface: Zippable

Zip (combine) this Zippable with the supplied Publisher, using the supplied combining function

Specified by:

zipP in interface Zippable<T>

Parameters:

app - to combine with

fn - Zip / combining function

Returns:

Combined zippable

Interface MonadicValue<T>

Nested Class Summary

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

Method Summary

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.types.Filters

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

Methods inherited from interface com.aol.cyclops2.types.functor.Transformable

Method Detail

arity

filter

unit

map

coflatMap

nest

flatMap

forEach4

forEach4

forEach3

forEach3

forEach2

forEach2

combineEager

flatMapI

flatMapS

flatMapP

combine

zip

zipP