CompletableFutureT (simple-react 1.0.0-RC2.3 API)

java.lang.Object
- com.aol.cyclops.control.monads.transformers.CompletableFutureT<A>

Type Parameters:

T -
```
public class CompletableFutureT<A>
extends java.lang.Object
```
Monad Transformer for Java CompletableFutures CompletableFutureT consists of an AnyM instance that in turns wraps anoter Monad type that contains an CompletableFuture CompletableFutureT>>> CompletableFutureT allows the deeply wrapped CompletableFuture to be manipulating within it's nested /contained context

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<B> CompletableFutureT<B>`	`flatMap(java.util.function.Function<? super A,CompletableFutureT<B>> f)` Flat Map the wrapped CompletableFuture
`static <A> CompletableFutureT<A>`	`fromAnyM(AnyM<A> anyM)` Construct an CompletableFutureT from an AnyM that contains a monad type that contains type other than CompletableFuture The values in the underlying monad will be mapped to CompletableFuture
`static <U,R> java.util.function.Function<CompletableFutureT<U>,CompletableFutureT<R>>`	`lift(java.util.function.Function<? super U,? extends R> fn)` Lift a function into one that accepts and returns an CompletableFutureT This allows multiple monad types to add functionality to existing functions and methods e.g.
`static <U1,U2,R> java.util.function.BiFunction<CompletableFutureT<U1>,CompletableFutureT<U2>,CompletableFutureT<R>>`	`lift2(java.util.function.BiFunction<? super U1,? super U2,? extends R> fn)` Lift a BiFunction into one that accepts and returns CompletableFutureTs This allows multiple monad types to add functionality to existing functions and methods e.g.
`<B> CompletableFutureT<B>`	`map(java.util.function.Function<? super A,? extends B> f)` Map the wrapped CompletableFuture
`static <A> CompletableFutureT<A>`	`of(AnyM<java.util.concurrent.CompletableFuture<A>> monads)` Construct an CompletableFutureT from an AnyM that wraps a monad containing CompletableFutures
`CompletableFutureT<A>`	`peek(java.util.function.Consumer<? super A> peek)` Peek at the current value of the CompletableFuture
`java.lang.String`	`toString()`
`AnyM<java.util.concurrent.CompletableFuture<A>>`	`unwrap()`

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

Method Detail

unwrap

public AnyM<java.util.concurrent.CompletableFuture<A>> unwrap()

Returns:: The wrapped AnyM

peek

public CompletableFutureT<A> peek(java.util.function.Consumer<? super A> peek)

Peek at the current value of the CompletableFuture

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

Parameters:: peek - Consumer to accept current value of CompletableFuture
Returns:: CompletableFutureT with peek call

map

public <B> CompletableFutureT<B> map(java.util.function.Function<? super A,? extends B> f)

Map the wrapped CompletableFuture

  
  CompletableFutureT.of(AnyM.fromStream(Arrays.asCompletableFuture(10))
             .map(t->t=t+1);
  
  
  //CompletableFutureT<AnyM<Stream<CompletableFuture[11]>>>

Parameters:: f - Mapping function for the wrapped CompletableFuture
Returns:: CompletableFutureT that applies the map function to the wrapped CompletableFuture

flatMap

public <B> CompletableFutureT<B> flatMap(java.util.function.Function<? super A,CompletableFutureT<B>> f)

Flat Map the wrapped CompletableFuture

  
  CompletableFutureT.of(AnyM.fromStream(Arrays.asCompletableFuture(10))
             .flatMap(t->CompletableFuture.completedFuture(20));
  
  
  //CompletableFutureT<AnyM<Stream<CompletableFuture[20]>>>

Parameters:: f - FlatMap function
Returns:: CompletableFutureT that applies the flatMap function to the wrapped CompletableFuture

lift

public static <U,R> java.util.function.Function<CompletableFutureT<U>,CompletableFutureT<R>> lift(java.util.function.Function<? super U,? extends R> fn)

Lift a function into one that accepts and returns an CompletableFutureT This allows multiple monad types to add functionality to existing functions and methods e.g. to add list handling / iteration (via CompletableFuture) and iteration (via Stream) to an existing function

  
	    Function<Integer,Integer> add2 = i -> i+2;
		Function<CompletableFutureT<Integer>, CompletableFutureT<Integer>> optTAdd2 = CompletableFutureT.lift(add2);
		
		Stream<Integer> withNulls = Stream.of(1,2,3);
		AnyM<Integer> stream = AnyM.fromStream(withNulls);
		AnyM<CompletableFuture<Integer>> streamOpt = stream.map(CompletableFuture::completedFuture);
		List<Integer> results = optTAdd2.apply(CompletableFutureT.of(streamOpt))
										.unwrap()
										.<Stream<CompletableFuture<Integer>>>unwrap()
										.map(CompletableFuture::join)
										.collect(Collectors.toList());
		
		
		//CompletableFuture.completedFuture(List[3,4]);

Parameters:: fn - Function to enhance with functionality from CompletableFuture and another monad type
Returns:: Function that accepts and returns an CompletableFutureT

lift2

public static <U1,U2,R> java.util.function.BiFunction<CompletableFutureT<U1>,CompletableFutureT<U2>,CompletableFutureT<R>> lift2(java.util.function.BiFunction<? super U1,? super U2,? extends R> fn)

Lift a BiFunction into one that accepts and returns CompletableFutureTs This allows multiple monad types to add functionality to existing functions and methods e.g. to add list handling / iteration (via CompletableFuture), iteration (via Stream) and asynchronous execution (CompletableFuture) to an existing function

  
  		BiFunction<Integer,Integer,Integer> add = (a,b) -> a+b;
		BiFunction<CompletableFutureT<Integer>,CompletableFutureT<Integer>,CompletableFutureT<Integer>> optTAdd2 = CompletableFutureT.lift2(add);
		
		Stream<Integer> withNulls = Stream.of(1,2,3);
		AnyM<Integer> stream = AnyM.ofMonad(withNulls);
		AnyM<CompletableFuture<Integer>> streamOpt = stream.map(CompletableFuture::completedFuture);
		
		CompletableFuture<CompletableFuture<Integer>> two = CompletableFuture.completedFuture(CompletableFuture.completedFuture(2));
		AnyM<CompletableFuture<Integer>> future=  AnyM.fromCompletableFuture(two);
		List<Integer> results = optTAdd2.apply(CompletableFutureT.of(streamOpt),CompletableFutureT.of(future))
										.unwrap()
										.<Stream<CompletableFuture<Integer>>>unwrap()
										.map(CompletableFuture::join)
										.collect(Collectors.toList());
										
  			//CompletableFuture.completedFuture(List[3,4,5]);

Parameters:: fn - BiFunction to enhance with functionality from CompletableFuture and another monad type
Returns:: Function that accepts and returns an CompletableFutureT

fromAnyM
```
public static <A> CompletableFutureT<A> fromAnyM(AnyM<A> anyM)
```
Construct an CompletableFutureT from an AnyM that contains a monad type that contains type other than CompletableFuture The values in the underlying monad will be mapped to CompletableFuture

Parameters:

anyM - AnyM that doesn't contain a monad wrapping an CompletableFuture

Returns:

CompletableFutureT

of
```
public static <A> CompletableFutureT<A> of(AnyM<java.util.concurrent.CompletableFuture<A>> monads)
```
Construct an CompletableFutureT from an AnyM that wraps a monad containing CompletableFutures

Parameters:

monads - AnyM that contains a monad wrapping an CompletableFuture

Returns:

CompletableFutureT

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

toString in class java.lang.Object

Class CompletableFutureT<A>