at.florianschuster.androidreactor

Class ViewModelReactor<Action,Mutation,State>

at.florianschuster.androidreactor.ViewModelReactor<Action,Mutation,State>

All Implemented Interfaces:

Reactor<Action,Mutation,State>

Direct Known Subclasses:

SimpleViewModelReactor

public class ViewModelReactor<Action,Mutation,State>
implements Reactor<Action,Mutation,State>

Abstract Reactor implementing ViewModel. It handles action and state creation and clearing of the state observable.

Nested Class Summary

Nested classes/interfaces inherited from interface at.florianschuster.androidreactor.Reactor

Reactor.DefaultImpls

Constructor Summary

Constructors

Constructor and Description
ViewModelReactor(State initialState, State currentState) Abstract Reactor implementing ViewModel. It handles action and state creation and clearing of the state observable.

Method Summary

Modifier and Type	Method and Description
com.jakewharton.rxrelay2.PublishRelay<Action>	getAction() The action from the view. Bind user inputs to this subject.
State	getCurrentState() The current state.
io.reactivex.disposables.CompositeDisposable	getDisposables() The CompositeDisposable that contains the State Stream disposable.
State	getInitialState() The initial state.
io.reactivex.Observable<? extends State>	getState() The state stream. Use this observable to observe the state changes.
void	onCleared()
void	setCurrentState(State p) The current state.

Methods inherited from interface at.florianschuster.androidreactor.Reactor

createStateStream, getAction, getCurrentState, getDisposables, getInitialState, getState, mutate, reduce, setCurrentState, transformAction, transformMutation, transformState

Constructor Detail

ViewModelReactor

public ViewModelReactor(State initialState,
                        State currentState)

Abstract Reactor implementing ViewModel. It handles action and state creation and clearing of the state observable.

Parameters:

initialState - The initial state.

currentState - The current state. This value is changed just after the state stream emits a new state.

Method Detail

getDisposables

public io.reactivex.disposables.CompositeDisposable getDisposables()

The CompositeDisposable that contains the State Stream disposable.

getAction

public com.jakewharton.rxrelay2.PublishRelay<Action> getAction()

The action from the view. Bind user inputs to this subject.

getState

public io.reactivex.Observable<? extends State> getState()

The state stream. Use this observable to observe the state changes.

onCleared

public void onCleared()

getInitialState

public State getInitialState()

The initial state.

getCurrentState

public State getCurrentState()

The current state.

This value is changed just after the state stream emits a new state.

setCurrentState

public void setCurrentState(State p)

The current state.

This value is changed just after the state stream emits a new state.

Parameters:

p - The current state. This value is changed just after the state stream emits a new state.