com.aol.cyclops.monad.functions

Class LiftMFunctions

java.lang.Object

com.aol.cyclops.monad.functions.LiftMFunctions

public class LiftMFunctions
extends java.lang.Object

Lift functions / method references to a higher level of abstraction Transparently inject behaviour via Monads. e.g. Use Stream to inject iteration, Try for error handling, Optional for null handling, CompletableFuture for async execution

Constructor Summary

Constructors

Constructor and Description
LiftMFunctions()

Method Summary

Modifier and Type	Method and Description
static <U,R> java.util.function.Function<AnyM<U>,AnyM<R>>	liftM(java.util.function.Function<U,R> fn) Lift a function so it accepts an AnyM (any monad) and returns an AnyM
static <U1,U2,R> java.util.function.BiFunction<AnyM<U1>,AnyM<U2>,AnyM<R>>	liftM2(java.util.function.BiFunction<U1,U2,R> fn) Lift a function so it accepts a Monad and returns a Monad (simplex view of a wrapped Monad) AnyM view simplifies type related challenges.
static <U1,U2,R> java.util.function.Function<AnyM<U1>,java.util.function.Function<AnyM<U2>,AnyM<R>>>	liftM2(java.util.function.Function<U1,java.util.function.Function<U2,R>> fn) Lift a Curried Function into Monadic form
static <U1,U2,U3,R> java.util.function.Function<AnyM<U1>,java.util.function.Function<AnyM<U2>,java.util.function.Function<AnyM<U3>,AnyM<R>>>>	liftM3(java.util.function.Function<U1,java.util.function.Function<U2,java.util.function.Function<U3,R>>> fn) Lift a Curried Function into Monadic form
static <U1,U2,U3,R> com.aol.cyclops.functions.TriFunction<AnyM<U1>,AnyM<U2>,AnyM<U3>,AnyM<R>>	liftM3(com.aol.cyclops.functions.TriFunction<U1,U2,U3,R> fn) Lift a TriFunction into Monadic form.
static <U1,U2,U3,U4,R> java.util.function.Function<AnyM<U1>,java.util.function.Function<AnyM<U2>,java.util.function.Function<AnyM<U3>,java.util.function.Function<AnyM<U4>,AnyM<R>>>>>	liftM4(java.util.function.Function<U1,java.util.function.Function<U2,java.util.function.Function<U3,java.util.function.Function<U4,R>>>> fn) Lift a Curried Function into Monadic form
static <U1,U2,U3,U4,R> com.aol.cyclops.functions.QuadFunction<AnyM<U1>,AnyM<U2>,AnyM<U3>,AnyM<U4>,AnyM<R>>	liftM4(com.aol.cyclops.functions.QuadFunction<U1,U2,U3,U4,R> fn) Lift a QuadFunction into Monadic form.
static <U1,U2,U3,U4,U5,R> java.util.function.Function<AnyM<U1>,java.util.function.Function<AnyM<U2>,java.util.function.Function<AnyM<U3>,java.util.function.Function<AnyM<U4>,java.util.function.Function<AnyM<U5>,AnyM<R>>>>>>	liftM5(java.util.function.Function<U1,java.util.function.Function<U2,java.util.function.Function<U3,java.util.function.Function<U4,java.util.function.Function<U5,R>>>>> fn) Lift a Curried Function (5 levels a->b->c->d->e->fn.apply(a,b,c,d,e) ) into Monadic form
static <U1,U2,U3,U4,U5,R> com.aol.cyclops.functions.QuintFunction<AnyM<U1>,AnyM<U2>,AnyM<U3>,AnyM<U4>,AnyM<U5>,AnyM<R>>	liftM5(com.aol.cyclops.functions.QuintFunction<U1,U2,U3,U4,U5,R> fn) Lift a QuintFunction (5 parameters) into Monadic form

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LiftMFunctions

public LiftMFunctions()

Method Detail

liftM

public static <U,R> java.util.function.Function<AnyM<U>,AnyM<R>> liftM(java.util.function.Function<U,R> fn)

Lift a function so it accepts an AnyM (any monad) and returns an AnyM

Parameters:

fn -

Returns:

liftM2

public static <U1,U2,R> java.util.function.BiFunction<AnyM<U1>,AnyM<U2>,AnyM<R>> liftM2(java.util.function.BiFunction<U1,U2,R> fn)

Lift a function so it accepts a Monad and returns a Monad (simplex view of a wrapped Monad) AnyM view simplifies type related challenges. The actual native type is not specified here. Example of lifting an existing method to add error handling (Try Monad) and iteration (Stream monad)

 
	 	//using Lombok val to simplify verbose generics
	    val divide = LiftMFunctions.liftM2(this::divide);
		
		AnyM<Integer> result = divide.apply(anyM(Try.of(2, ArithmeticException.class)), anyM(Stream.of(10,1,2,3)));
		
		assertThat(result.<Try<List<Integer>,ArithmeticException>>unwrapMonad().get(),equalTo(Arrays.asList(0, 2, 1, 0)));
	  
	  	private Integer divide(Integer a, Integer b){
			return a/b;
		}
 
 

Parameters:

fn -

Returns:

liftM3

public static <U1,U2,U3,R> com.aol.cyclops.functions.TriFunction<AnyM<U1>,AnyM<U2>,AnyM<U3>,AnyM<R>> liftM3(com.aol.cyclops.functions.TriFunction<U1,U2,U3,R> fn)

Lift a TriFunction into Monadic form. A good use case it to take an existing method and lift it so it can accept and return monads

 
 TriFunction<AnyM<Double>,AnyM<Entity>,AnyM<String>,AnyM<Integer>> fn = liftM3(this::myMethod);
    
 
 

Now we can execute the Method with Streams, Optional, Futures, Try's etc to transparently inject iteration, null handling, async execution and / or error handling

Parameters:

fn - Function to lift

Returns:

Lifted function

liftM4

public static <U1,U2,U3,U4,R> com.aol.cyclops.functions.QuadFunction<AnyM<U1>,AnyM<U2>,AnyM<U3>,AnyM<U4>,AnyM<R>> liftM4(com.aol.cyclops.functions.QuadFunction<U1,U2,U3,U4,R> fn)

Lift a QuadFunction into Monadic form.

Parameters:

fn - Quad funciton to lift

Returns:

Lifted Quad function

liftM5

public static <U1,U2,U3,U4,U5,R> com.aol.cyclops.functions.QuintFunction<AnyM<U1>,AnyM<U2>,AnyM<U3>,AnyM<U4>,AnyM<U5>,AnyM<R>> liftM5(com.aol.cyclops.functions.QuintFunction<U1,U2,U3,U4,U5,R> fn)

Lift a QuintFunction (5 parameters) into Monadic form

Parameters:

fn - Function to lift

Returns:

Lifted Function

liftM2

public static <U1,U2,R> java.util.function.Function<AnyM<U1>,java.util.function.Function<AnyM<U2>,AnyM<R>>> liftM2(java.util.function.Function<U1,java.util.function.Function<U2,R>> fn)

Lift a Curried Function into Monadic form

Parameters:

fn - Function to lift

Returns:

Lifted function

liftM3

public static <U1,U2,U3,R> java.util.function.Function<AnyM<U1>,java.util.function.Function<AnyM<U2>,java.util.function.Function<AnyM<U3>,AnyM<R>>>> liftM3(java.util.function.Function<U1,java.util.function.Function<U2,java.util.function.Function<U3,R>>> fn)

Lift a Curried Function into Monadic form

Parameters:

fn - Function to lift

Returns:

Lifted function

liftM4

public static <U1,U2,U3,U4,R> java.util.function.Function<AnyM<U1>,java.util.function.Function<AnyM<U2>,java.util.function.Function<AnyM<U3>,java.util.function.Function<AnyM<U4>,AnyM<R>>>>> liftM4(java.util.function.Function<U1,java.util.function.Function<U2,java.util.function.Function<U3,java.util.function.Function<U4,R>>>> fn)

Lift a Curried Function into Monadic form

Parameters:

fn - Function to lift

Returns:

Lifted function

liftM5

public static <U1,U2,U3,U4,U5,R> java.util.function.Function<AnyM<U1>,java.util.function.Function<AnyM<U2>,java.util.function.Function<AnyM<U3>,java.util.function.Function<AnyM<U4>,java.util.function.Function<AnyM<U5>,AnyM<R>>>>>> liftM5(java.util.function.Function<U1,java.util.function.Function<U2,java.util.function.Function<U3,java.util.function.Function<U4,java.util.function.Function<U5,R>>>>> fn)

Lift a Curried Function (5 levels a->b->c->d->e->fn.apply(a,b,c,d,e) ) into Monadic form

Parameters:

fn - Function to lift

Returns:

Lifted function