de.halfbit.knot

Class KnotBuilder.ChangesBuilder<State,Change,Action>

de.halfbit.knot.KnotBuilder.ChangesBuilder<State,Change,Action>

Enclosing class:

KnotBuilder<State,Change,Action>

public static class KnotBuilder.ChangesBuilder<State,Change,Action>

Method Summary

Modifier and Type	Method and Description
Effect<State,Action>	getOnly(State $receiver) Turns State into an class Effect without Action.
io.reactivex.Scheduler	getReduceOn() An optional Scheduler used for reduce function.
io.reactivex.Scheduler	getWatchOn() An optional Scheduler used for watching Changes.
void	intercept(kotlin.jvm.functions.Function1<? super io.reactivex.Observable<Change>,? extends io.reactivex.Observable<Change>> interceptor) A function for intercepting Change emissions.
Effect.WithAction<State,Action>	plus(State $receiver, Action action) Combines State and Action into class Effect.
void	reduce(kotlin.jvm.functions.Function2<? super State,? super Change,? extends de.halfbit.knot.Effect<State,Action>> reducer) Mandatory reduce function which receives the current State and a Change and must return class Effect with a new State and an optional Action.
void	setReduceOn(io.reactivex.Scheduler p) An optional Scheduler used for reduce function.
void	setWatchOn(io.reactivex.Scheduler value) An optional Scheduler used for watching Changes.
java.lang.Void	unexpected(State $receiver, Change change) Throws IllegalStateException with current State and given Change in its message.
void	watchAll(kotlin.jvm.functions.Function1<? super Change,kotlin.Unit> watcher) A function for watching Change emissions.

Method Detail

getReduceOn

public io.reactivex.Scheduler getReduceOn()

An optional Scheduler used for reduce function.

setReduceOn

public void setReduceOn(io.reactivex.Scheduler p)

An optional Scheduler used for reduce function.

getWatchOn

public io.reactivex.Scheduler getWatchOn()

An optional Scheduler used for watching Changes.

setWatchOn

public void setWatchOn(io.reactivex.Scheduler value)

An optional Scheduler used for watching Changes.

reduce

public void reduce(kotlin.jvm.functions.Function2<? super State,? super Change,? extends de.halfbit.knot.Effect<State,Action>> reducer)

Mandatory reduce function which receives the current State and a Change and must return class Effect with a new State and an optional Action.

New State and Action can be joined together using overloaded State.plus operator. For returning State without action call .only on the state.

Example:

changes {
    reduce { change ->
        when (change) {
            is Change.Load -> copy(value = "loading") + Action.Load
            is Change.Load.Success -> copy(value = change.payload).only
            is Change.Load.Failure -> copy(value = "failed").only
        }
    }
}

See Also:

class Effect, State.plus

intercept

public void intercept(kotlin.jvm.functions.Function1<? super io.reactivex.Observable<Change>,? extends io.reactivex.Observable<Change>> interceptor)

A function for intercepting Change emissions.

watchAll

public void watchAll(kotlin.jvm.functions.Function1<? super Change,kotlin.Unit> watcher)

A function for watching Change emissions.

getOnly

public Effect<State,Action> getOnly(State $receiver)

Turns State into an class Effect without Action.

See Also:

class Effect

plus

public Effect.WithAction<State,Action> plus(State $receiver,
                                            Action action)

Combines State and Action into class Effect.

See Also:

class Effect

unexpected

public java.lang.Void unexpected(State $receiver,
                                 Change change)

Throws IllegalStateException with current State and given Change in its message.

See Also:

IllegalStateException