/*
* Copyright 2015 Hannes Dorfmann.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.hannesdorfmann.mosby3.mvp.viewstate;
import com.hannesdorfmann.mosby3.mvp.MvpActivity;
import com.hannesdorfmann.mosby3.mvp.MvpPresenter;
import com.hannesdorfmann.mosby3.mvp.MvpView;
import com.hannesdorfmann.mosby3.mvp.delegate.ActivityMvpDelegate;
import com.hannesdorfmann.mosby3.mvp.delegate.ActivityMvpViewStateDelegateImpl;
import com.hannesdorfmann.mosby3.mvp.delegate.MvpViewStateDelegateCallback;
/**
* This is a enhancement of {@link com.hannesdorfmann.mosby3.mvp.MvpActivity} that introduces the
* support of {@link RestorableViewState}.
* <p>
* You can change the behaviour of what to do if the viewstate is empty (usually if the activity
* creates the viewState for the very first time and therefore has no state / data to restore) by
* overriding {@link #onNewViewStateInstance()}
* </p>
*
* @author Hannes Dorfmann
* @since 1.0.0
*/
public abstract class MvpViewStateActivity<V extends MvpView, P extends MvpPresenter<V>, VS extends ViewState<V>>
extends MvpActivity<V, P> implements MvpViewStateDelegateCallback<V, P, VS> {
protected VS viewState;
/**
* A simple flag that indicates if the restoring ViewState is in progress right now.
*/
protected boolean restoringViewState = false;
@Override protected ActivityMvpDelegate<V, P> getMvpDelegate() {
if (mvpDelegate == null) {
mvpDelegate = new ActivityMvpViewStateDelegateImpl<>(this, this, true);
}
return mvpDelegate;
}
@Override public VS getViewState() {
return viewState;
}
@Override public void setViewState(VS viewState) {
this.viewState = viewState;
}
@Override public void setRestoringViewState(boolean restoringViewState) {
this.restoringViewState = restoringViewState;
}
@Override public boolean isRestoringViewState() {
return restoringViewState;
}
@Override public void onViewStateInstanceRestored(boolean instanceStateRetained) {
// not needed. You could override this is subclasses if needed
}
}