Package com.github.tonivade.purefun.instances

Class MonadMTL<F extends Kind<F,?>,S,R,E>

java.lang.Object

com.github.tonivade.purefun.instances.MonadMTL<F,S,R,E>

All Implemented Interfaces:

Applicative<MonadMTL.EffectS<F,S,R,E,?>>, ApplicativeError<MonadMTL.EffectS<F,S,R,E,?>,E>, Functor<MonadMTL.EffectS<F,S,R,E,?>>, Invariant<MonadMTL.EffectS<F,S,R,E,?>>, Monad<MonadMTL.EffectS<F,S,R,E,?>>, MonadError<MonadMTL.EffectS<F,S,R,E,?>,E>, MonadReader<MonadMTL.EffectS<F,S,R,E,?>,R>, MonadState<MonadMTL.EffectS<F,S,R,E,?>,S>, Selective<MonadMTL.EffectS<F,S,R,E,?>>

public class MonadMTL<F extends Kind<F,?>,S,R,E>
extends Object
implements Monad<MonadMTL.EffectS<F,S,R,E,?>>, MonadError<MonadMTL.EffectS<F,S,R,E,?>,E>, MonadState<MonadMTL.EffectS<F,S,R,E,?>,S>, MonadReader<MonadMTL.EffectS<F,S,R,E,?>,R>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MonadMTL.EffectE<F extends Kind<F,?>,E,A>
static final class	MonadMTL.EffectR<F extends Kind<F,?>,R,E,A>
static final class	MonadMTL.EffectS<F extends Kind<F,?>,S,R,E,A>

Nested classes/interfaces inherited from interface com.github.tonivade.purefun.typeclasses.Applicative

Applicative.Map2<F extends Kind<F,?>,A,B>, Applicative.Map3<F extends Kind<F,?>,A,B,C>, Applicative.Map4<F extends Kind<F,?>,A,B,C,D>, Applicative.Map5<F extends Kind<F,?>,A,B,C,D,E>

Field Summary

Fields

Modifier and Type	Field	Description
private final Monad<F>	monad
private final MonadError<MonadMTL.EffectE<F,E,?>,E>	monadErrorE
private final MonadError<StateT<MonadMTL.EffectR<F,R,E,?>,S,?>,E>	monadErrorS
private final Monad<MonadMTL.EffectR<F,R,E,?>>	monadR
private final MonadReader<StateT<MonadMTL.EffectR<F,R,E,?>,S,?>,R>	monadReaderS
private final MonadState<StateT<MonadMTL.EffectR<F,R,E,?>,S,?>,S>	monadStateS

Constructor Summary

Constructors

Constructor	Description
MonadMTL(Monad<F> monad)

Method Summary

Modifier and Type	Method	Description
MonadMTL.EffectS<F,S,R,E,R>	ask()
<A> MonadMTL.EffectS<F,S,R,E,A>	effect(Kind<F,Either<E,A>> value)
<A> MonadMTL.EffectE<F,E,A>	effectE(Kind<F,Either<E,A>> value)
<A> MonadMTL.EffectR<F,R,E,A>	effectR(MonadMTL.EffectE<F,E,A> effect0)
<A> MonadMTL.EffectS<F,S,R,E,A>	effectS(MonadMTL.EffectR<F,R,E,A> effect1)
<A, B> MonadMTL.EffectS<F,S,R,E,B>	flatMap(Kind<MonadMTL.EffectS<F,S,R,E,?>,? extends A> value, Function1<? super A,? extends Kind<MonadMTL.EffectS<F,S,R,E,?>,? extends B>> map)
MonadMTL.EffectS<F,S,R,E,S>	get()
<A> MonadMTL.EffectS<F,S,R,E,A>	handleErrorWith(Kind<MonadMTL.EffectS<F,S,R,E,?>,A> value, Function1<? super E,? extends Kind<MonadMTL.EffectS<F,S,R,E,?>,? extends A>> handler)
<A> MonadMTL.EffectS<F,S,R,E,A>	pure(A value)
<A> MonadMTL.EffectS<F,S,R,E,A>	raiseError(E error)
MonadMTL.EffectS<F,S,R,E,Unit>	set(S state)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.tonivade.purefun.typeclasses.Applicative

first, last, mapN, mapN, mapN, mapN, mapN, mapN, mapN, mapN, tuple, tuple, tuple, tuple

Methods inherited from interface com.github.tonivade.purefun.typeclasses.ApplicativeError

attempt, fromEither, handleError, recover, recoverWith

Methods inherited from interface com.github.tonivade.purefun.typeclasses.Functor

imap, lift

Methods inherited from interface com.github.tonivade.purefun.typeclasses.Monad

andThen, ap, flatten, map, select, tailRecM, use

Methods inherited from interface com.github.tonivade.purefun.typeclasses.MonadError

ensure, repeat, repeatOrElse, repeatOrElseEither, retry, retryOrElse, retryOrElseEither

Methods inherited from interface com.github.tonivade.purefun.typeclasses.MonadReader

reader

Methods inherited from interface com.github.tonivade.purefun.typeclasses.MonadState

inspect, modify, state

Methods inherited from interface com.github.tonivade.purefun.typeclasses.Selective

allS, allS, andS, anyS, anyS, branch, ifS, orS, whenS

Field Details

monad

private final Monad<F extends Kind<F,?>> monad

monadErrorE

private final MonadError<MonadMTL.EffectE<F extends Kind<F,?>,E,?>,E> monadErrorE

monadR

private final Monad<MonadMTL.EffectR<F extends Kind<F,?>,R,E,?>> monadR

monadErrorS

private final MonadError<StateT<MonadMTL.EffectR<F extends Kind<F,?>,R,E,?>,S,?>,E> monadErrorS

monadReaderS

private final MonadReader<StateT<MonadMTL.EffectR<F extends Kind<F,?>,R,E,?>,S,?>,R> monadReaderS

monadStateS

private final MonadState<StateT<MonadMTL.EffectR<F extends Kind<F,?>,R,E,?>,S,?>,S> monadStateS

Constructor Details

MonadMTL

public MonadMTL(Monad<F> monad)

Method Details

pure

public <A> MonadMTL.EffectS<F,S,R,E,A> pure(A value)

Specified by:

pure in interface Applicative<F extends Kind<F,?>>

flatMap

public <A,
B> MonadMTL.EffectS<F,S,R,E,B> flatMap(Kind<MonadMTL.EffectS<F,S,R,E,?>,? extends A> value,
 Function1<? super A,? extends Kind<MonadMTL.EffectS<F,S,R,E,?>,? extends B>> map)

Specified by:

flatMap in interface Monad<F extends Kind<F,?>>

get

public MonadMTL.EffectS<F,S,R,E,S> get()

Specified by:

get in interface MonadState<F extends Kind<F,?>,S>

set

public MonadMTL.EffectS<F,S,R,E,Unit> set(S state)

Specified by:

set in interface MonadState<F extends Kind<F,?>,S>

raiseError

public <A> MonadMTL.EffectS<F,S,R,E,A> raiseError(E error)

Specified by:

raiseError in interface ApplicativeError<F extends Kind<F,?>,S>

handleErrorWith

public <A> MonadMTL.EffectS<F,S,R,E,A> handleErrorWith(Kind<MonadMTL.EffectS<F,S,R,E,?>,A> value,
 Function1<? super E,? extends Kind<MonadMTL.EffectS<F,S,R,E,?>,? extends A>> handler)

Specified by:

handleErrorWith in interface ApplicativeError<F extends Kind<F,?>,S>

ask

public MonadMTL.EffectS<F,S,R,E,R> ask()

Specified by:

ask in interface MonadReader<F extends Kind<F,?>,S>

effectE

public <A> MonadMTL.EffectE<F,E,A> effectE(Kind<F,Either<E,A>> value)

effectR

public <A> MonadMTL.EffectR<F,R,E,A> effectR(MonadMTL.EffectE<F,E,A> effect0)

effectS

public <A> MonadMTL.EffectS<F,S,R,E,A> effectS(MonadMTL.EffectR<F,R,E,A> effect1)

effect

public <A> MonadMTL.EffectS<F,S,R,E,A> effect(Kind<F,Either<E,A>> value)