ReaderT (cyclops-reactor 9.0.0-FINAL API)

java.lang.Object
- cyclops.monads.transformers.ReaderT<W,T,R>

Type Parameters:

T - Type of data stored inside the nested Future(s)

All Implemented Interfaces:

To<ReaderT<W,T,R>>, Transformable<R>, Fn1<T,R>, java.util.function.Function<T,R>
```
public final class ReaderT<W extends WitnessType<W>,T,R>
extends java.lang.Object
implements To<ReaderT<W,T,R>>, Transformable<R>, Fn1<T,R>
```
Monad Transformer for Future's nested within another monadic type FutureT allows the deeply wrapped Future to be manipulating within it's nested /contained context

Nested Class Summary
- Nested classes/interfaces inherited from interface cyclops.function.Fn1
  Fn1.FunctionalOperations<T1,R>

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`R`	`apply(T a)`
`<U> ReaderT<W,T,U>`	`cast(java.lang.Class<? extends U> type)` Cast all elements in a reactiveStream to a given type, possibly throwing a `ClassCastException`.
`boolean`	`equals(java.lang.Object o)`
`<B> ReaderT<W,T,B>`	`flatMap(java.util.function.Function<? super R,? extends Reader<T,B>> f)`
`<B> ReaderT<W,T,B>`	`flatMapT(java.util.function.Function<? super R,ReaderT<W,T,B>> f)`
`<R1,R4> ReaderT<W,T,R4>`	`forEach2(java.util.function.Function<? super R,java.util.function.Function<T,R1>> value2, java.util.function.BiFunction<? super R,? super R1,? extends R4> yieldingFunction)`
`<R1,B> ReaderT<W,T,B>`	`forEach2M(java.util.function.Function<? super R,? extends ReaderT<W,T,R1>> value1, java.util.function.BiFunction<? super R,? super R1,? extends B> yieldingFunction)`
`<R1,R2,R4> ReaderT<W,T,R4>`	`forEach3(java.util.function.Function<? super R,? extends java.util.function.Function<T,R1>> value2, java.util.function.BiFunction<? super R,? super R1,? extends java.util.function.Function<T,R2>> value3, Fn3<? super R,? super R1,? super R2,? extends R4> yieldingFunction)`
`<T2,R1,R2,B> ReaderT<W,T,B>`	`forEach3M(java.util.function.Function<? super R,? extends ReaderT<W,T,R1>> value1, java.util.function.BiFunction<? super R,? super R1,? extends ReaderT<W,T,R2>> value2, Fn3<? super R,? super R1,? super R2,? extends B> yieldingFunction)`
`<R1,R2,R3,R4> ReaderT<W,T,R4>`	`forEach4(java.util.function.Function<? super R,? extends java.util.function.Function<T,R1>> value2, java.util.function.BiFunction<? super R,? super R1,? extends java.util.function.Function<T,R2>> value3, Fn3<? super R,? super R1,? super R2,? extends java.util.function.Function<T,R3>> value4, Fn4<? super R,? super R1,? super R2,? super R3,? extends R4> yieldingFunction)`
`<T2,R1,R2,R3,B> ReaderT<W,T,B>`	`forEach4M(java.util.function.Function<? super R,? extends ReaderT<W,T,R1>> value1, java.util.function.BiFunction<? super R,? super R1,? extends ReaderT<W,T,R2>> value2, Fn3<? super R,? super R1,? super R2,? extends ReaderT<W,T,R3>> value3, Fn4<? super R,? super R1,? super R2,? super R3,? extends B> yieldingFunction)`
`int`	`hashCode()`
`<B> ReaderT<W,T,B>`	`map(java.util.function.Function<? super R,? extends B> f)` Map the wrapped Future
`java.lang.String`	`mkString()`
`static <W extends WitnessType<W>,T,R> ReaderT<W,T,R>`	`of(AnyM<W,Reader<T,R>> monads)` Construct an FutureT from an AnyM that wraps a monad containing Futures
`ReaderT<W,T,R>`	`peek(java.util.function.Consumer<? super R> peek)` Peek at the current value of the Future
`java.lang.String`	`toString()`
`<R2> ReaderT<W,T,R2>`	`trampoline(java.util.function.Function<? super R,? extends Trampoline<? extends R2>> mapper)` Performs a map operation that can call a recursive method without running out of stack space
`AnyM<W,Reader<T,R>>`	`unwrap()`
`<R2> R2`	`unwrapTo(java.util.function.Function<? super AnyM<W,Reader<T,R>>,? extends R2> fn)`

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

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

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

Methods inherited from interface cyclops.function.Fn1
after, always, andThen, andThen, applyLazy, before, bind, compose, fanIn, firstFn, functionOps, later, leftFn, lift, lift, liftAnyM, liftF, liftNT, liftOpt, liftTry, memoize, memoize, memoizeAsync, memoizeAsync, merge, narrow, now, product, product, product, reader, rightFn, secondFn, λ, λv

Methods inherited from interface java.util.function.Function
identity

Method Detail

unwrap
```
public AnyM<W,Reader<T,R>> unwrap()
```
Returns:

The wrapped AnyM

unwrapTo

public <R2> R2 unwrapTo(java.util.function.Function<? super AnyM<W,Reader<T,R>>,? extends R2> fn)

peek

public ReaderT<W,T,R> peek(java.util.function.Consumer<? super R> peek)

Peek at the current value of the Future

  
    FutureT.of(AnyM.fromStream(Arrays.asFuture(10))
             .peek(System.out::println);
             
     //prints 10

Specified by:: peek in interface Transformable<R>
Parameters:: peek - Consumer to accept current value of Future
Returns:: FutureT with peek call

map

public <B> ReaderT<W,T,B> map(java.util.function.Function<? super R,? extends B> f)

Map the wrapped Future

  
  FutureT.of(AnyM.fromStream(Arrays.asFuture(10))
             .map(t->t=t+1);
  
  
  //FutureT<AnyMSeq<Stream<Future[11]>>>

Specified by:: map in interface Transformable<R>
Parameters:: f - Mapping function for the wrapped Future
Returns:: FutureT that applies the map function to the wrapped Future

flatMap

public <B> ReaderT<W,T,B> flatMap(java.util.function.Function<? super R,? extends Reader<T,B>> f)

flatMapT

public <B> ReaderT<W,T,B> flatMapT(java.util.function.Function<? super R,ReaderT<W,T,B>> f)

of
```
public static <W extends WitnessType<W>,T,R> ReaderT<W,T,R> of(AnyM<W,Reader<T,R>> monads)
```
Construct an FutureT from an AnyM that wraps a monad containing Futures

Parameters:

monads - AnyM that contains a monad wrapping an Future

Returns:

FutureT

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

forEach4M

public <T2,R1,R2,R3,B> ReaderT<W,T,B> forEach4M(java.util.function.Function<? super R,? extends ReaderT<W,T,R1>> value1,
                                                java.util.function.BiFunction<? super R,? super R1,? extends ReaderT<W,T,R2>> value2,
                                                Fn3<? super R,? super R1,? super R2,? extends ReaderT<W,T,R3>> value3,
                                                Fn4<? super R,? super R1,? super R2,? super R3,? extends B> yieldingFunction)

forEach3M

public <T2,R1,R2,B> ReaderT<W,T,B> forEach3M(java.util.function.Function<? super R,? extends ReaderT<W,T,R1>> value1,
                                             java.util.function.BiFunction<? super R,? super R1,? extends ReaderT<W,T,R2>> value2,
                                             Fn3<? super R,? super R1,? super R2,? extends B> yieldingFunction)

forEach2M

public <R1,B> ReaderT<W,T,B> forEach2M(java.util.function.Function<? super R,? extends ReaderT<W,T,R1>> value1,
                                       java.util.function.BiFunction<? super R,? super R1,? extends B> yieldingFunction)

forEach4

public <R1,R2,R3,R4> ReaderT<W,T,R4> forEach4(java.util.function.Function<? super R,? extends java.util.function.Function<T,R1>> value2,
                                              java.util.function.BiFunction<? super R,? super R1,? extends java.util.function.Function<T,R2>> value3,
                                              Fn3<? super R,? super R1,? super R2,? extends java.util.function.Function<T,R3>> value4,
                                              Fn4<? super R,? super R1,? super R2,? super R3,? extends R4> yieldingFunction)

forEach3

public <R1,R2,R4> ReaderT<W,T,R4> forEach3(java.util.function.Function<? super R,? extends java.util.function.Function<T,R1>> value2,
                                           java.util.function.BiFunction<? super R,? super R1,? extends java.util.function.Function<T,R2>> value3,
                                           Fn3<? super R,? super R1,? super R2,? extends R4> yieldingFunction)

forEach2

public <R1,R4> ReaderT<W,T,R4> forEach2(java.util.function.Function<? super R,java.util.function.Function<T,R1>> value2,
                                        java.util.function.BiFunction<? super R,? super R1,? extends R4> yieldingFunction)

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

equals
```
public boolean equals(java.lang.Object o)
```
Overrides:

equals in class java.lang.Object

mkString
```
public java.lang.String mkString()
```

cast
```
public <U> ReaderT<W,T,U> cast(java.lang.Class<? extends U> type)
```
Description copied from interface: Transformable

Cast all elements in a reactiveStream to a given type, possibly throwing a ClassCastException. // ClassCastException ReactiveSeq.of(1, "a", 2, "b", 3).cast(Integer.class)

Specified by:

cast in interface Transformable<R>

trampoline

public <R2> ReaderT<W,T,R2> trampoline(java.util.function.Function<? super R,? extends Trampoline<? extends R2>> mapper)

Description copied from interface: Transformable

Performs a map operation that can call a recursive method without running out of stack space

 
 ReactiveSeq.of(10,20,30,40)
    			 .trampoline(i-> fibonacci(i))
    			 .forEach(System.out::println);

    	Trampoline<Long> fibonacci(int i){
    		return fibonacci(i,1,0);
    	}
    	Trampoline<Long> fibonacci(int n, long a, long b) {
        	return n == 0 ? Trampoline.done(b) : Trampoline.more( ()->fibonacci(n-1, a+b, a));
    	}

 55
    	6765
    	832040
    	102334155


 ReactiveSeq.of(10_000,200_000,3_000_000,40_000_000)
    			 .trampoline(i-> fibonacci(i))
    			 .forEach(System.out::println);


 completes successfully

Specified by:: trampoline in interface Transformable<R>
Parameters:: mapper - TCO Transformation function
Returns:: Transformable transformed by the supplied transformation function

apply
```
public R apply(T a)
```
Specified by:

apply in interface Fn1<T,R>

Specified by:

apply in interface java.util.function.Function<T,R>

Class ReaderT<W extends WitnessType<W>,T,R>

Nested Class Summary

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

Method Summary

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface cyclops.function.Fn1

Methods inherited from interface java.util.function.Function

Method Detail

unwrap

unwrapTo

peek

map

flatMap

flatMapT

of

toString

forEach4M

forEach3M

forEach2M

forEach4

forEach3

forEach2

hashCode

equals

mkString

cast

trampoline

apply