Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

am 53ec4a66: am 474bb82f: Merge "Clarify docs for BackupTransport.initializeDevice()" into mnc-dev

Browse Source 
* commit '53ec4a66630ce14a4ad9e2976dd9863a12fe092c':
  Clarify docs for BackupTransport.initializeDevice()
This commit is contained in:
Christopher Tate
2015-05-14 22:34:08 +00:00
committed by Android Git Automerger
parent d2115eaa66 53ec4a6663
commit ea3c13d2aa
1 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
core/java/android/app/backup/BackupTransport.java
View File

@@ -162,8 +162,17 @@ public class BackupTransport {
* this is called, {@link #finishBackup} will be called to ensure the request
* is sent and received successfully.
*
* <p>If the transport returns anything other than TRANSPORT_OK from this method,
* the OS will halt the current initialize operation and schedule a retry in the
* near future. Even if the transport is in a state such that attempting to
* "initialize" the backend storage is meaningless -- for example, if there is
* no current live dataset at all, or there is no authenticated account under which
* to store the data remotely -- the transport should return TRANSPORT_OK here
* and treat the initializeDevice() / finishBackup() pair as a graceful no-op.
*
* @return One of {@link BackupTransport#TRANSPORT_OK} (OK so far) or
* {@link BackupTransport#TRANSPORT_ERROR} (on network error or other failure).
* {@link BackupTransport#TRANSPORT_ERROR} (to retry following network error
* or other failure).
*/
public int initializeDevice() {
return BackupTransport.TRANSPORT_ERROR;