CompletableFutureT

cyclops-react : User guide

CompletableFutureT

CompletableFutureT class allow you to manipulate an Optional/s wrapped inside any other monad type (via AnyM). Like AnyM, CompletableFutureT has two sub-types CompletableFutureTValue and CompletableFutureTSeq

CompletableFutureTValue

CompletableFutureTValue represents an Optional that is nested inside another monad that resolves to a single value (e.g. an Optional / Maybe / Either / Try / Future type).

CompletableFutureTSeq

CompletableFutureTSeq represents an Optional that is nested inside another monad that resolves to a sequence of values (e.g. an Stream or List type).

CompletableFutureT

Other monad transformers in Cyclops

• OptionalT
• XorT
• CompletableFutureT
• MaybeT
• StreamT
• StreamableT
• CompletableFutureT
• ListT
• SetT
• TryT

Creating an CompletableFutureT

You can build CompletableFutureT from static creational methods on CompletableFutureT such as fromValue or fromIterable

CompletableFutureTValue<Integer> valueT = CompletableFutureT.fromValue(Maybe.just(CompletableFuture.completedFuture(10));
CompletableFutureTSeq<Integer>  seqT = CompletableFutureT.fromIterable(Arrays.asList(new CompletableFuture(),CompletableFuture.completedFuture(10));

Transforming CompletableFutureT

map

transformation operation

valueT.map(i->i*2);

//CompletableFutureT[Maybe[FutureW[20]]

flatMap

flattening transformation

valueT.flatMap(i->CompletableFuture.completedFuture(i*2));

//CompletableFutureT[Maybe[FutureW[20]]

flatMapT

A flatMap operator where the transforming function returns another monad transformer

valueT.flatMapT(i->CompletableFutureT.fromOptional(Optional.of(CompletableFuture.completedFuture(i*2)));

//CompletableFutureT[Optional[FutureW[20]]

Converting to other types

1. CompletableFutureT#unwrap will return the wrapped monad, in general this should only be used locally within the same method that the AnyM is created so we can be sure of it's type.
2. CompletableFutureTValue#toXXXX, CompletableFutureTSeq#toXXX there are a large range of conversion operators available on the CompletableFutureTValue and CompletableFutureTSeq types that can convert CompletableFutureT's to JDK or cyclops-react monadic types
3. CompletableFutureT#collect JDK 8 collectors can be used to convert an CompletableFutureT from one type to another
4. CompletableFutureT#to The to method allows both custom operators and custom converters to be used to convert an CompletableFutureT to another type

Folding / Reduction

AnyM types also have a full range of fold / reduce operators available, which means that data can often be extracted in useful form without conversion back to an unwrapped monadic form.

E.g. to sum all the values in any Sequence type we can write a generic method like so ->

public int sumValues(CompletableFutureT<Integer> sequence){
     return sequence.reduce(Monoids.intSum);
}  

Reactive Streams

AnyM extends Publisher so other reactive Streams implementations can subscribe to our AnyM type.

ReactiveSeq<FutureW<Integer>> stream =  ReactiveSeq.of(1,2,3).map(FutureW::ofResult);
CompletableFutureTSeq<Integer> seq = CompletableFutureT.fromIterable(stream);

Flux<Integer> flux = Flux.from(seq); 

forEach, forEachWithErrors

Similarly we can provide a consumer to listen to each event generated by the wrapped monadic type as we iterate over it.

CompletableFutureTValue<Integer> value = CompletableFutureT.fromValue(CompletableFuture.completedFuture(Future.ofResult(10)));
CompletableFutureTSeq<Integer> seq = CompletableFutureT.fromIterable(ReactiveSeq.of(
                                                                  Future.ofResult(10),
                                                                  Future.ofResult(20),
                                                                  Future.ofResult(30)));

value.forEach(System.out::println);
//10

seq.forEach(System.out::println);
//10
//20
/30