Home | History | Annotate | Download | only in backup 
      1 /*
      2  * Copyright (C) 2010 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 package android.app.backup;
     18 
     19 import java.lang.String;
     20 
     21 import android.annotation.SystemApi;
     22 import android.app.backup.RestoreSet;
     23 
     24 /**
     25  * Callback class for receiving progress reports during a restore operation.  These
     26  * methods will all be called on your application's main thread.
     27  */
     28 public abstract class RestoreObserver {
     29     /**
     30      * Supply a list of the restore datasets available from the current transport.  This
     31      * method is invoked as a callback following the application's use of the
     32      * {@link android.app.backup.IRestoreSession.getAvailableRestoreSets} method.
     33      *
     34      * @param result An array of {@link android.app.backup.RestoreSet RestoreSet} objects
     35      *   describing all of the available datasets that are candidates for restoring to
     36      *   the current device.  If no applicable datasets exist, {@code result} will be
     37      *   {@code null}.
     38      *
     39      * @hide
     40      */
     41     @SystemApi
     42     public void restoreSetsAvailable(RestoreSet[] result) {
     43     }
     44 
     45     /**
     46      * The restore operation has begun.
     47      *
     48      * @param numPackages The total number of packages being processed in
     49      *   this restore operation.
     50      */
     51     public void restoreStarting(int numPackages) {
     52     }
     53 
     54     /**
     55      * An indication of which package is being restored currently, out of the
     56      * total number provided in the {@link #restoreStarting(int)} callback.  This method
     57      * is not guaranteed to be called: if the transport is unable to obtain
     58      * data for one or more of the requested packages, no onUpdate() call will
     59      * occur for those packages.
     60      *
     61      * @param nowBeingRestored The index, between 1 and the numPackages parameter
     62      *   to the {@link #restoreStarting(int)} callback, of the package now being
     63      *   restored.  This may be non-monotonic; it is intended purely as a rough
     64      *   indication of the backup manager's progress through the overall restore process.
     65      * @param currentPackage The name of the package now being restored.
     66      */
     67     public void onUpdate(int nowBeingRestored, String currentPackage) {
     68     }
     69 
     70     /**
     71      * The restore process has completed.  This method will always be called,
     72      * even if no individual package restore operations were attempted.
     73      *
     74      * @param error Zero on success; a nonzero error code if the restore operation
     75      *   as a whole failed.
     76      */
     77     public void restoreFinished(int error) {
     78     }
     79 }
     80