MonadicValue (cyclops-reactor 8.4.2 API)

Type Parameters:

T - Data type of element stored inside this Monad

All Superinterfaces:

Convertable<T>, Filterable<T>, Foldable<T>, Functor<T>, java.lang.Iterable<T>, java.util.function.Predicate<T>, org.reactivestreams.Publisher<T>, java.util.function.Supplier<T>, Unit<T>, Value<T>, Visitable<T>, Zippable<T>

All Known Subinterfaces:

AnyMValue<T>, Eval<T>, FeatureToggle<T>, Ior<ST,PT>, Maybe<T>, TransformerValue<T>, Try<T,X>, Xor<ST,PT>

All Known Implementing Classes:

AnyMValueImpl, CompletableFutureTValue, Eval.Module.Always, Eval.Module.Later, EvalTValue, FeatureToggle.Disabled, FeatureToggle.Enabled, FutureW, FutureWTValue, Ior.Both, Ior.Primary, Ior.Secondary, Maybe.Just, Maybe.Lazy, Maybe.Nothing, MaybeTValue, MonoTValue, OptionalTValue, Try.Failure, Try.Success, TryTValue, Xor.Primary, Xor.Secondary, XorTValue
```
public interface MonadicValue<T>
extends Value<T>, Unit<T>, Functor<T>, Filterable<T>
```
A type that represents a Monad that wraps a single value

Nested Class Summary
- Nested classes/interfaces inherited from interface com.aol.cyclops.types.Value
  Value.ValueImpl<T>
- Nested classes/interfaces inherited from interface com.aol.cyclops.types.Convertable
  Convertable.SupplierToConvertable<T>

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default AnyMValue<T>`	`anyM()`
`default <R> MonadicValue<R>`	`coflatMap(java.util.function.Function<? super MonadicValue<T>,R> mapper)` Perform a coflatMap operation.
`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>`	`flatMapIterable(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>`	`flatMapPublisher(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 <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 stream
`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, TriFunction<? 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, TriFunction<? super T,? super R1,? super R2,java.lang.Boolean> filterFunction, TriFunction<? 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, TriFunction<? super T,? super R1,? super R2,? extends MonadicValue<R3>> value3, QuadFunction<? 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, TriFunction<? super T,? super R1,? super R2,? extends MonadicValue<R3>> value3, QuadFunction<? super T,? super R1,? super R2,? super R3,java.lang.Boolean> filterFunction, QuadFunction<? 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)`

Methods inherited from interface com.aol.cyclops.types.Value
collect, fold, fold, generate, iterate, iterator, mapReduce, mkString, newSubscriber, of, stream, subscribe, test, toDequeX, toEvalAlways, toEvalLater, toEvalNow, toFeatureToggle, toFutureStream, toFutureStream, toIor, toLazyImmutable, toList, toListX, toMaybe, toMutable, toPBagX, toPOrderedSetX, toPQueueX, toPSetX, toPStackX, toPVectorX, toQueueX, toSetX, toSimpleReact, toSimpleReact, toSortedSetX, toTry, toTry, toTry, toXor, toXor, unapply

Methods inherited from interface com.aol.cyclops.types.Foldable
endsWith, endsWithIterable, findAny, findFirst, firstValue, foldable, foldRight, foldRight, foldRight, foldRightMapToType, get, groupBy, join, join, join, mapReduce, print, print, printErr, printOut, reduce, reduce, reduce, reduce, reduce, reduce, reduce, schedule, scheduleFixedDelay, scheduleFixedRate, single, single, singleOptional, startsWith, startsWithIterable, toConcurrentLazyCollection, toConcurrentLazyStreamable, toLazyCollection, validate, xMatch

Methods inherited from interface com.aol.cyclops.types.Convertable
collect, fromSupplier, get, isPresent, orElse, orElseGet, orElseThrow, toAtomicReference, toCompletableFuture, toCompletableFutureAsync, toCompletableFutureAsync, toFutureW, toFutureWAsync, toFutureWAsync, toOptional, toOptionalAtomicReference, toStream, visit

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

Methods inherited from interface com.aol.cyclops.types.Zippable
zip, zip, zip, zip, zip, zip, zip

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

Methods inherited from interface com.aol.cyclops.types.Functor
cast, patternMatch, peek, trampoline

Methods inherited from interface com.aol.cyclops.types.Filterable
filterNot, notNull, ofType

Method Detail

filter
```
MonadicValue<T> filter(java.util.function.Predicate<? super T> predicate)
```
Description copied from interface: Filterable
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 Filterable<T>

Parameters:

predicate - to filter elements by, retaining matches

Returns:

Filterable 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: Functor
Transform this functor using the supplied transformation function
```
  
  
  
    of(1,2,3).map(i->i*2)
    
    //[2,4,6]
  
 
 
```
Specified by:

map in interface Functor<T>

Parameters:

fn - Transformation function

Returns:

Transformed Functor

anyM
```
default AnyMValue<T> anyM()
```
Returns:

This monad wrapped as an AnyMValue

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 single 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,
                                                 TriFunction<? super T,? super R1,? super R2,? extends MonadicValue<R3>> value3,
                                                 QuadFunction<? 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,
                                                 TriFunction<? super T,? super R1,? super R2,? extends MonadicValue<R3>> value3,
                                                 QuadFunction<? super T,? super R1,? super R2,? super R3,java.lang.Boolean> filterFunction,
                                                 QuadFunction<? 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 apply 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,
                                              TriFunction<? 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,
                                              TriFunction<? super T,? super R1,? super R2,java.lang.Boolean> filterFunction,
                                              TriFunction<? 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 apply 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 stream

  
  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 apply 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. lazy / async alternatives)

  
 
  Monoid<Integer> add = Monoid.of(1,Semigroups.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 , Semigroups.firstNonNull());
  Maybe.of(10).combineEager(firstNonNull,Maybe.of(10));
  //Maybe[10]

Parameters:: monoid -; v2 -
Returns:

flatMapIterable

default <R> MonadicValue<R> flatMapIterable(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).flatMapIterable(i->Arrays.asList(()->i*3,20);
   //Maybe[9]

Parameters:: mapper - transformation function
Returns:: MonadicValue

flatMapPublisher

default <R> MonadicValue<R> flatMapPublisher(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.

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

Parameters:: mapper - transformation function
Returns:: MonadicValue

Interface MonadicValue<T>

Nested Class Summary

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

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

Method Summary

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

Methods inherited from interface com.aol.cyclops.types.Foldable

Methods inherited from interface com.aol.cyclops.types.Convertable

Methods inherited from interface java.util.function.Predicate

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

Methods inherited from interface java.lang.Iterable

Methods inherited from interface com.aol.cyclops.types.Functor

Methods inherited from interface com.aol.cyclops.types.Filterable

Method Detail

filter

unit

map

anyM

coflatMap

nest

flatMap

forEach4

forEach4

forEach3

forEach3

forEach2

forEach2

combineEager

flatMapIterable

flatMapPublisher