com.aol.cyclops.lambda.api

Interface Comprehender<T>

Type Parameters:

T - Monadic Type being wrapped

All Known Implementing Classes:

CompletableFutureComprehender, InvokeDynamicComprehender, ListComprehender, OptionalComprehender, SetComprehender, StreamableComprehender, StreamComprehender

public interface Comprehender<T>

Interface for defining how Comprehensions should work for a type Cyclops For Comprehensions will supply either a JDK 8 Predicate or Function for filter / map / flatMap The comprehender should wrap these in a suitable type and make the call to the underlying Monadic Type (T) the Comprehender implementation supports. E.g. To support mapping for the Functional Java Option type wrap the supplied JDK 8 Function in a Functional Java fj.F type, call the make call to option.map( ) and retun the result.

  OptionComprehender<Option> {
    
     public Object map(Option o, Function fn){
        return o.map( a-> fn.apply(a));
     }
     
 }
 

Method Summary

Modifier and Type	Method and Description
T	empty()
default java.lang.Object	executeflatMap(T t, java.util.function.Function fn) Wrapper around flatMap
default java.lang.Object	filter(T t, java.util.function.Predicate p) Wrapper around filter
java.lang.Object	flatMap(T t, java.util.function.Function fn)
java.lang.Class	getTargetClass()
default boolean	instanceOfT(java.lang.Object apply)
default java.lang.Object	liftAndFlatMap(T t, java.util.function.Function fn) A flatMap function that allows flatMapping to a different Monad type will attempt to lift any non-Monadic values returned into a Monadic form
static java.lang.Object	liftObject(Comprehender comp, java.lang.Object apply)
java.lang.Object	map(T t, java.util.function.Function fn) Wrapper around map
T	of(java.lang.Object o)
default int	priority()
default java.lang.Object	resolveForCrossTypeFlatMap(Comprehender comp, T apply) Answers the question how should this type behave when returned in a flatMap function by another type? For example - Optional uses comp.of(opt.get()) when a value is present and comp.empty() when no value is present.
default T	unwrap(java.lang.Object o)
static <T> T	unwrapOtherMonadTypes(Comprehender<T> comp, java.lang.Object apply)

Method Detail

priority

default int priority()

unwrap

default T unwrap(java.lang.Object o)

filter

default java.lang.Object filter(T t,
                                java.util.function.Predicate p)

Wrapper around filter

Parameters:

t - Monadic type being wrapped

p - JDK Predicate to wrap

Returns:

Result of call to

 t.filter ( i -> p.test(i)); 

map

java.lang.Object map(T t,
                     java.util.function.Function fn)

Wrapper around map

Parameters:

t - Monadic type being wrapped

fn - JDK Function to wrap

Returns:

Result of call to

 t.map( i -> fn.apply(i)); 

liftAndFlatMap

default java.lang.Object liftAndFlatMap(T t,
                                        java.util.function.Function fn)

A flatMap function that allows flatMapping to a different Monad type will attempt to lift any non-Monadic values returned into a Monadic form

Parameters:

t - Monad to perform flatMap on

fn - FlatMap function that returns different type

Returns:

flatMap applied and return type converted back to host type, non-Monadic return values lifted into a Monadic form

executeflatMap

default java.lang.Object executeflatMap(T t,
                                        java.util.function.Function fn)

Wrapper around flatMap

Parameters:

t - Monadic type being wrapped

fn - JDK Function to wrap

Returns:

Result of call to

 t.flatMap( i -> fn.apply(i)); 

flatMap

java.lang.Object flatMap(T t,
                         java.util.function.Function fn)

instanceOfT

default boolean instanceOfT(java.lang.Object apply)

of

T of(java.lang.Object o)

empty

T empty()

liftObject

static java.lang.Object liftObject(Comprehender comp,
                                   java.lang.Object apply)

unwrapOtherMonadTypes

static <T> T unwrapOtherMonadTypes(Comprehender<T> comp,
                                   java.lang.Object apply)

resolveForCrossTypeFlatMap

default java.lang.Object resolveForCrossTypeFlatMap(Comprehender comp,
                                                    T apply)

Answers the question how should this type behave when returned in a flatMap function by another type? For example - Optional uses comp.of(opt.get()) when a value is present and comp.empty() when no value is present.

Parameters:

comp -

apply -

Returns:

getTargetClass

java.lang.Class getTargetClass()