Package com.github.tonivade.purefun.monad

Interface State<S,A>

All Superinterfaces:

Bindable<State<S,?>,A>, Kind<State<S,?>,A>, Mappable<State<S,?>,A>, StateOf<S,A>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public non-sealed interface State<S,A>
extends StateOf<S,A>, Bindable<State<S,?>,A>

Method Summary

Modifier and Type	Method	Description
default <R> State<S,R>	andThen(Kind<State<S,?>,? extends R> next)
default A	eval(S state)
default <R> State<S,R>	flatMap(Function1<? super A,? extends Kind<State<S,?>,? extends R>> mapper)
static <S> State<S,S>	get()
static <S, A> State<S,A>	inspect(Function1<? super S,? extends A> mapper)
default <R> State<S,R>	map(Function1<? super A,? extends R> mapper)
static <S, A, B, C> State<S,C>	map2(State<S,? extends A> sa, State<S,? extends B> sb, Function2<? super A,? super B,? extends C> mapper)
static <S> State<S,Unit>	modify(Operator1<S> mapper)
static <S, A> State<S,A>	pure(A value)
Tuple2<S,A>	run(S state)
default S	runS(S state)
static <S> State<S,Unit>	set(S value)
static <S, A> State<S,A>	state(Function1<S,Tuple2<S,A>> runState)
static <S, A> State<S,Sequence<A>>	traverse(Sequence<State<S,A>> states)

Methods inherited from interface com.github.tonivade.purefun.Kind

fix, kind

Method Details

run

Tuple2<S,A> run(S state)

map

default <R> State<S,R> map(Function1<? super A,? extends R> mapper)

Specified by:

map in interface Bindable<S,A>

Specified by:

map in interface Mappable<S,A>

flatMap

default <R> State<S,R> flatMap(Function1<? super A,? extends Kind<State<S,?>,? extends R>> mapper)

Specified by:

flatMap in interface Bindable<S,A>

andThen

default <R> State<S,R> andThen(Kind<State<S,?>,? extends R> next)

Specified by:

andThen in interface Bindable<S,A>

eval

default A eval(S state)

runS

default S runS(S state)

state

static <S,
A> State<S,A> state(Function1<S,Tuple2<S,A>> runState)

pure

static <S,
A> State<S,A> pure(A value)

get

static <S> State<S,S> get()

set

static <S> State<S,Unit> set(S value)

modify

static <S> State<S,Unit> modify(Operator1<S> mapper)

inspect

static <S,
A> State<S,A> inspect(Function1<? super S,? extends A> mapper)

traverse

static <S,
A> State<S,Sequence<A>> traverse(Sequence<State<S,A>> states)

map2

static <S,
A,
B,
C> State<S,C> map2(State<S,? extends A> sa,
 State<S,? extends B> sb,
 Function2<? super A,? super B,? extends C> mapper)