MviDelegateCallback.java

/*
 *  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;

import android.support.annotation.NonNull;
import com.hannesdorfmann.mosby3.mvi.MviPresenter;
import com.hannesdorfmann.mosby3.mvp.MvpView;

/**
 * Callback that will be called to instantiate the presenter.
 *
 * @author Hannes Dorfmann
 * @since 3.0.0
 */
public interface MviDelegateCallback<V extends MvpView, P extends MviPresenter<V, ?>> {

  /**
   * Creates the presenter instance
   *
   * @return the created presenter instance
   */
  @NonNull P createPresenter();

  /**
   * Get the MvpView for the presenter
   *
   * @return The viewState associated with the presenter
   */
  @NonNull V getMvpView();

  /**
   * This method will be called to inform that restoring
   * the view state is in progress (true as parameter value) and when restoring is finished (false
   * as parameter value). Typically this is set to true when the view is reattached to the
   * presenter
   * after orientation changes or when navigating back from backstack.
   * Usually this is useful if you want to know whether or not you should run certain animations
   * because of the state of the view has changed or the view has been reattached to the presenter
   * (i.e. orientation change, coming back from back stack) and therefore no animations should run.
   *
   * @param restoringViewState true, if restoring view state is in progress, otherwise false
   */
  void setRestoringViewState(boolean restoringViewState);
}