1 /*
2  * Copyright (C) 2022 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 
18 package com.android.wallpaper.picker.undo.domain.interactor
19 
20 import com.android.wallpaper.picker.undo.shared.model.RestorableSnapshot
21 
22 /** Defines interface for classes that can handle state restoration. */
23 interface SnapshotRestorer {
24 
25     /**
26      * Sets up the restorer.
27      *
28      * @param store An object the can be used when a new snapshot should be stored; use this in
29      *   response to state changes that you wish could be restored when the user asks to reset the
30      *   changes.
31      * @return A snapshot of the initial state as it was at the moment that this method was invoked.
32      */
setUpSnapshotRestorernull33     suspend fun setUpSnapshotRestorer(store: SnapshotStore): RestorableSnapshot
34 
35     /** Restores the state to what is described in the given snapshot. */
36     suspend fun restoreToSnapshot(snapshot: RestorableSnapshot)
37 }
38