1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
/*
* Copyright (C) 2007 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 android.backup;
import android.app.BackupAgent;
import android.backup.BackupHelper;
import android.backup.BackupHelperDispatcher;
import android.backup.BackupDataInput;
import android.backup.BackupDataOutput;
import android.os.ParcelFileDescriptor;
import android.util.Log;
import java.io.IOException;
/**
* A convenient BackupAgent wrapper class that automatically manages heterogeneous
* data sets within the backup data, each identified by a unique key prefix. An
* application will typically extend this class in their own backup agent. Then,
* within the agent's onBackup() and onRestore() methods, it will call
* {@link #addHelper(String, BackupHelper)} one or more times to specify the data
* sets, then invoke super.onBackup() or super.onRestore() to have the BackupHelperAgent
* implementation process the data.
*
* STOPSHIP: document!
*/
public class BackupHelperAgent extends BackupAgent {
static final String TAG = "BackupHelperAgent";
BackupHelperDispatcher mDispatcher = new BackupHelperDispatcher();
/**
* Run the backup process on each of the configured handlers.
*/
@Override
public void onBackup(ParcelFileDescriptor oldState, BackupDataOutput data,
ParcelFileDescriptor newState) throws IOException {
mDispatcher.performBackup(oldState, data, newState);
}
/**
* Run the restore process on each of the configured handlers.
*/
@Override
public void onRestore(BackupDataInput data, int appVersionCode, ParcelFileDescriptor newState)
throws IOException {
mDispatcher.performRestore(data, appVersionCode, newState);
}
/** @hide */
public BackupHelperDispatcher getDispatcher() {
return mDispatcher;
}
/**
* Add a helper for a given data subset to the agent's configuration. Each helper
* must have a prefix string that is unique within this backup agent's set of
* helpers.
*
* @param keyPrefix A string used to disambiguate the various helpers within this agent
* @param helper A backup/restore helper object to be invoked during backup and restore
* operations.
*/
public void addHelper(String keyPrefix, BackupHelper helper) {
mDispatcher.addHelper(keyPrefix, helper);
}
}
|
