am 245df5ad: am 3f264c4f: Merge "API CHANGE: rename BackupHelperAgent => BackupAgentHelper per API Council" into froyo

Merge commit '245df5ad16ff227761906c10dc97c01901232666' into kraken

* commit '245df5ad16ff227761906c10dc97c01901232666':
  API CHANGE: rename BackupHelperAgent => BackupAgentHelper per API Council
This commit is contained in:
Christopher Tate
2010-03-29 15:57:01 -07:00
committed by Android Git Automerger
10 changed files with 89 additions and 87 deletions

View File

@@ -37,7 +37,7 @@ import java.io.IOException;
* respectively.
* <p>
* A backup agent based on convenient helper classes is available in
* {@link android.app.backup.BackupHelperAgent} for less complex implementation
* {@link android.app.backup.BackupAgentHelper} for less complex implementation
* requirements.
* <p>
* STOPSHIP write more documentation about the backup process here.

View File

@@ -27,12 +27,12 @@ import java.io.IOException;
* 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.
* have the BackupAgentHelper implementation process the data.
* <p>
* STOPSHIP: document!
*/
public class BackupHelperAgent extends BackupAgent {
static final String TAG = "BackupHelperAgent";
public class BackupAgentHelper extends BackupAgent {
static final String TAG = "BackupAgentHelper";
BackupHelperDispatcher mDispatcher = new BackupHelperDispatcher();

View File

@@ -20,7 +20,7 @@ import android.os.ParcelFileDescriptor;
/**
* A convenient interface to be used with the
* {@link android.app.backup.BackupHelperAgent} to implement backup and restore of
* {@link android.app.backup.BackupAgentHelper} to implement backup and restore of
* arbitrary data types.
* <p>
* STOPSHOP: document!
@@ -36,7 +36,8 @@ public interface BackupHelper {
ParcelFileDescriptor newState);
/**
* Called by BackupHelperAgent to restore one entity from the restore dataset.
* Called by {@link android.app.backup.BackupAgentHelper BackupAgentHelper}
* to restore one entity from the restore dataset.
* <p class=note>
* Do not close the <code>data</code> stream. Do not read more than
* <code>data.size()</code> bytes from <code>data</code>.
@@ -44,7 +45,8 @@ public interface BackupHelper {
public void restoreEntity(BackupDataInputStream data);
/**
* Called by BackupHelperAgent to write the new backup state file corresponding to
* Called by {@link android.app.backup.BackupAgentHelper BackupAgentHelper}
* to write the new backup state file corresponding to
* the current state of the app's data at the time the backup operation was
* performed.
*/

View File

@@ -41,7 +41,7 @@ import android.util.Log;
* of how the backup then proceeds.
* <p>
* A simple implementation of a BackupAgent useful for backing up Preferences
* and files is available by using {@link android.app.backup.BackupHelperAgent}.
* and files is available by using {@link android.app.backup.BackupAgentHelper}.
* <p>
* STOPSHIP: more documentation!
* <p>

View File

@@ -24,7 +24,7 @@ import java.io.File;
/**
* A helper class which can be used in conjunction with
* {@link android.app.backup.BackupHelperAgent} to manage the backup of a set of
* {@link android.app.backup.BackupAgentHelper} to manage the backup of a set of
* files. Whenever backup is performed, all files changed since the last backup
* will be saved in their entirety. During the first time the backup happens,
* all the files in the list will be backed up. Note that this should only be
@@ -69,7 +69,7 @@ public class FileBackupHelper extends FileBackupHelperBase implements BackupHelp
* now. When <code>oldState</code> is <code>null</code>, all the files will
* be backed up.
* <p>
* This should be called from {@link android.app.backup.BackupHelperAgent}
* This should be called from {@link android.app.backup.BackupAgentHelper}
* directly. See
* {@link android.app.backup.BackupAgent#onBackup(ParcelFileDescriptor, BackupDataOutput, ParcelFileDescriptor)}
* for a description of parameter meanings.

View File

@@ -25,7 +25,7 @@ import java.io.File;
/**
* A helper class which can be used in conjunction with
* {@link android.app.backup.BackupHelperAgent} to manage the backup of
* {@link android.app.backup.BackupAgentHelper} to manage the backup of
* {@link android.content.SharedPreferences}. Whenever backup is performed it
* will back up all named shared preferences which have changed since the last
* backup.