/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * 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.android.messaging.ui;

import android.os.Parcelable;

/**
 * Wraps around functionality to save, restore and reset a particular UI component's state.
 */
public interface PersistentInstanceState {
    /**
     * Saves necessary information about the current state of the instance to later restore
     * the instance to its original state.
     */
    Parcelable saveState();

    /**
     * Given a previously saved instance state, attempt to restore to its original view state.
     */
    void restoreState(Parcelable restoredState);

    /**
     * Called when any current/preserved state should be reset to zero state.
     */
    void resetState();
}