Package com.github.tonivade.purefun.typeclasses

Interface Monad<F extends Kind<F,?>>

All Superinterfaces:

Applicative<F>, Functor<F>, Invariant<F>, Selective<F>

All Known Subinterfaces:

Async<F>, Bracket<F,E>, Concurrent<F>, EIOAsync, EIOBracket<E>, EIOConcurrent, EIOMonad<E>, EIOMonadDefer, EIOMonadError<E>, EIOMonadThrow, EitherMonad<L>, EitherMonadError<L>, EitherMonadThrow, EitherTBracket<F,E>, EitherTMonad<F,L>, EitherTMonadDefer<F>, EitherTMonadErrorFromMonad<F,E>, EitherTMonadErrorFromMonadError<F,E>, EitherTMonadThrowFromMonad<F>, EitherTMonadThrowFromMonadThrow<F>, EvalMonad, EvalMonadError, EvalMonadThrow, FreeMonad<F>, Function1Monad<T>, FutureMonad, FutureMonadThrow, IdMonad, IOAsync, IOBracket, IOConcurrent, IOMonad, IOMonadDefer, IOMonadError, IOMonadThrow, KleisliMonad<F,Z>, KleisliMonadError<F,R,E>, KleisliMonadReader<F,R>, KleisliMonadState<F,R,S>, MonadDefer<F>, MonadError<F,E>, MonadReader<F,R>, MonadState<F,S>, MonadThrow<F>, MonadWriter<F,W>, OptionMonad, OptionMonadError, OptionTBracket<F>, OptionTMonad<F>, OptionTMonadDefer<F>, OptionTMonadErrorFromMonad<F>, OptionTMonadErrorFromMonadError<F,E>, OptionTMonadThrow<F>, ProducerMonad, PromiseMonad, PureIOAsync<R>, PureIOBracket<R,E>, PureIOConcurrent<R>, PureIOMonad<R,E>, PureIOMonadDefer<R>, PureIOMonadError<R,E>, PureIOMonadThrow<R>, PureStreamMonad<F>, ReaderMonad<R>, ReaderMonadReader<R>, RIOAsync<R>, RIOBracket<R>, RIOConcurrent<R>, RIOMonad<R>, RIOMonadDefer<R>, RIOMonadError<R>, RIOMonadThrow<R>, SequenceMonad, StateMonad<S>, StateMonadState<S>, StateTMonad<F,S>, StateTMonadError<F,S,E>, StateTMonadReader<F,S,R>, StateTMonadState<F,S>, TaskAsync, TaskBracket, TaskConcurrent, TaskMonad, TaskMonadDefer, TaskMonadError, TaskMonadThrow, TrampolineMonad, TryMonad, TryMonadError, TryMonadThrow, UIOAsync, UIOBracket, UIOConcurrent, UIOMonad, UIOMonadDefer, UIOMonadError, UIOMonadThrow, URIOAsync<R>, URIOBracket<R>, URIOConcurrent<R>, URIOMonad<R>, URIOMonadDefer<R>, URIOMonadError<R>, URIOMonadThrow<R>, ValidationMonad<E>, ValidationMonadError<E>, ValidationMonadThrow, WriterMonad<L>, WriterTMonad<F,L>, WriterTMonadError<F,L,E>, WriterTMonadWriter<F,L>

All Known Implementing Classes:

EffectEMonadError, EffectRMonad, EffectRMonadError, EffectRMonadReader, MonadMTL, ReferenceMonadState

public interface Monad<F extends Kind<F,?>>
extends Selective<F>

Nested Class Summary

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>

Method Summary

Modifier and Type	Method	Description
default <T, R> Kind<F,R>	andThen(Kind<F,? extends T> value, Producer<? extends Kind<F,? extends R>> next)
default <T, R> Kind<F,R>	ap(Kind<F,? extends T> value, Kind<F,? extends Function1<? super T,? extends R>> apply)
<T, R> Kind<F,R>	flatMap(Kind<F,? extends T> value, Function1<? super T,? extends Kind<F,? extends R>> map)
default <T> Kind<F,T>	flatten(Kind<F,Kind<F,? extends T>> value)
default <T, R> Kind<F,R>	map(Kind<F,? extends T> value, Function1<? super T,? extends R> map)
default <A, B> Kind<F,B>	select(Kind<F,Either<A,B>> value, Kind<F,Function1<? super A,? extends B>> apply)
default <T, R> Kind<F,R>	tailRecM(T value, Function1<T,? extends Kind<F,Either<T,R>>> map)
default For.FlatMap<F>	use()

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

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

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

imap, lift

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

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

Method Details

flatMap

<T,
R> Kind<F,R> flatMap(Kind<F,? extends T> value,
 Function1<? super T,? extends Kind<F,? extends R>> map)

use

default For.FlatMap<F> use()

tailRecM

default <T,
R> Kind<F,R> tailRecM(T value,
 Function1<T,? extends Kind<F,Either<T,R>>> map)

andThen

default <T,
R> Kind<F,R> andThen(Kind<F,? extends T> value,
 Producer<? extends Kind<F,? extends R>> next)

flatten

default <T> Kind<F,T> flatten(Kind<F,Kind<F,? extends T>> value)

map

default <T,
R> Kind<F,R> map(Kind<F,? extends T> value,
 Function1<? super T,? extends R> map)

Specified by:

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

Specified by:

map in interface Functor<F extends Kind<F,?>>

ap

default <T,
R> Kind<F,R> ap(Kind<F,? extends T> value,
 Kind<F,? extends Function1<? super T,? extends R>> apply)

Specified by:

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

select

default <A,
B> Kind<F,B> select(Kind<F,Either<A,B>> value,
 Kind<F,Function1<? super A,? extends B>> apply)

Specified by:

select in interface Selective<F extends Kind<F,?>>