From 6aa05b82d82cb8bb4d8149e83750b03c3708dfd1 Mon Sep 17 00:00:00 2001
From: Michal Karpinski <mkarpinski@google.com>
Date: Wed, 9 Aug 2017 17:24:59 +0100
Subject: [PATCH] Add "Threading" section to BackupAgent's class level javadoc

Test: make -j40 docs
Bug: 34326112
Change-Id: I3038de3f7159b92c72fa714f9ed55159fe3bb66b
---
 core/java/android/app/backup/BackupAgent.java | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/core/java/android/app/backup/BackupAgent.java b/core/java/android/app/backup/BackupAgent.java
index 42e6147203847..7aa80d2639766 100644
--- a/core/java/android/app/backup/BackupAgent.java
+++ b/core/java/android/app/backup/BackupAgent.java
@@ -103,6 +103,18 @@ import java.util.concurrent.CountDownLatch;
  * {@link android.app.backup.BackupAgentHelper}.  That class is particularly
  * suited to handling of simple file or {@link android.content.SharedPreferences}
  * backup and restore.
+ * <p>
+ * <b>Threading</b>
+ * <p>
+ * The constructor, as well as {@link #onCreate()} and {@link #onDestroy()} lifecycle callbacks run
+ * on the main thread (UI thread) of the application that implements the BackupAgent.
+ * The data-handling callbacks:
+ * {@link #onBackup(ParcelFileDescriptor, BackupDataOutput, ParcelFileDescriptor) onBackup()},
+ * {@link #onFullBackup(FullBackupDataOutput)},
+ * {@link #onRestore(BackupDataInput, int, ParcelFileDescriptor) onRestore()},
+ * {@link #onRestoreFile(ParcelFileDescriptor, long, File, int, long, long) onRestoreFile()},
+ * {@link #onRestoreFinished()}, and {@link #onQuotaExceeded(long, long) onQuotaExceeded()}
+ * run on binder pool threads.
  *
  * @see android.app.backup.BackupManager
  * @see android.app.backup.BackupAgentHelper