1 /* 2 * Copyright (C) 2008 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.os; 18 19 import android.annotation.MainThread; 20 import android.annotation.WorkerThread; 21 22 import java.util.ArrayDeque; 23 import java.util.concurrent.BlockingQueue; 24 import java.util.concurrent.Callable; 25 import java.util.concurrent.CancellationException; 26 import java.util.concurrent.Executor; 27 import java.util.concurrent.ExecutionException; 28 import java.util.concurrent.FutureTask; 29 import java.util.concurrent.LinkedBlockingQueue; 30 import java.util.concurrent.ThreadFactory; 31 import java.util.concurrent.ThreadPoolExecutor; 32 import java.util.concurrent.TimeUnit; 33 import java.util.concurrent.TimeoutException; 34 import java.util.concurrent.atomic.AtomicBoolean; 35 import java.util.concurrent.atomic.AtomicInteger; 36 37 /** 38 * <p>AsyncTask enables proper and easy use of the UI thread. This class allows you 39 * to perform background operations and publish results on the UI thread without 40 * having to manipulate threads and/or handlers.</p> 41 * 42 * <p>AsyncTask is designed to be a helper class around {@link Thread} and {@link Handler} 43 * and does not constitute a generic threading framework. AsyncTasks should ideally be 44 * used for short operations (a few seconds at the most.) If you need to keep threads 45 * running for long periods of time, it is highly recommended you use the various APIs 46 * provided by the <code>java.util.concurrent</code> package such as {@link Executor}, 47 * {@link ThreadPoolExecutor} and {@link FutureTask}.</p> 48 * 49 * <p>An asynchronous task is defined by a computation that runs on a background thread and 50 * whose result is published on the UI thread. An asynchronous task is defined by 3 generic 51 * types, called <code>Params</code>, <code>Progress</code> and <code>Result</code>, 52 * and 4 steps, called <code>onPreExecute</code>, <code>doInBackground</code>, 53 * <code>onProgressUpdate</code> and <code>onPostExecute</code>.</p> 54 * 55 * <div class="special reference"> 56 * <h3>Developer Guides</h3> 57 * <p>For more information about using tasks and threads, read the 58 * <a href="{@docRoot}guide/components/processes-and-threads.html">Processes and 59 * Threads</a> developer guide.</p> 60 * </div> 61 * 62 * <h2>Usage</h2> 63 * <p>AsyncTask must be subclassed to be used. The subclass will override at least 64 * one method ({@link #doInBackground}), and most often will override a 65 * second one ({@link #onPostExecute}.)</p> 66 * 67 * <p>Here is an example of subclassing:</p> 68 * <pre class="prettyprint"> 69 * private class DownloadFilesTask extends AsyncTask<URL, Integer, Long> { 70 * protected Long doInBackground(URL... urls) { 71 * int count = urls.length; 72 * long totalSize = 0; 73 * for (int i = 0; i < count; i++) { 74 * totalSize += Downloader.downloadFile(urls[i]); 75 * publishProgress((int) ((i / (float) count) * 100)); 76 * // Escape early if cancel() is called 77 * if (isCancelled()) break; 78 * } 79 * return totalSize; 80 * } 81 * 82 * protected void onProgressUpdate(Integer... progress) { 83 * setProgressPercent(progress[0]); 84 * } 85 * 86 * protected void onPostExecute(Long result) { 87 * showDialog("Downloaded " + result + " bytes"); 88 * } 89 * } 90 * </pre> 91 * 92 * <p>Once created, a task is executed very simply:</p> 93 * <pre class="prettyprint"> 94 * new DownloadFilesTask().execute(url1, url2, url3); 95 * </pre> 96 * 97 * <h2>AsyncTask's generic types</h2> 98 * <p>The three types used by an asynchronous task are the following:</p> 99 * <ol> 100 * <li><code>Params</code>, the type of the parameters sent to the task upon 101 * execution.</li> 102 * <li><code>Progress</code>, the type of the progress units published during 103 * the background computation.</li> 104 * <li><code>Result</code>, the type of the result of the background 105 * computation.</li> 106 * </ol> 107 * <p>Not all types are always used by an asynchronous task. To mark a type as unused, 108 * simply use the type {@link Void}:</p> 109 * <pre> 110 * private class MyTask extends AsyncTask<Void, Void, Void> { ... } 111 * </pre> 112 * 113 * <h2>The 4 steps</h2> 114 * <p>When an asynchronous task is executed, the task goes through 4 steps:</p> 115 * <ol> 116 * <li>{@link #onPreExecute()}, invoked on the UI thread before the task 117 * is executed. This step is normally used to setup the task, for instance by 118 * showing a progress bar in the user interface.</li> 119 * <li>{@link #doInBackground}, invoked on the background thread 120 * immediately after {@link #onPreExecute()} finishes executing. This step is used 121 * to perform background computation that can take a long time. The parameters 122 * of the asynchronous task are passed to this step. The result of the computation must 123 * be returned by this step and will be passed back to the last step. This step 124 * can also use {@link #publishProgress} to publish one or more units 125 * of progress. These values are published on the UI thread, in the 126 * {@link #onProgressUpdate} step.</li> 127 * <li>{@link #onProgressUpdate}, invoked on the UI thread after a 128 * call to {@link #publishProgress}. The timing of the execution is 129 * undefined. This method is used to display any form of progress in the user 130 * interface while the background computation is still executing. For instance, 131 * it can be used to animate a progress bar or show logs in a text field.</li> 132 * <li>{@link #onPostExecute}, invoked on the UI thread after the background 133 * computation finishes. The result of the background computation is passed to 134 * this step as a parameter.</li> 135 * </ol> 136 * 137 * <h2>Cancelling a task</h2> 138 * <p>A task can be cancelled at any time by invoking {@link #cancel(boolean)}. Invoking 139 * this method will cause subsequent calls to {@link #isCancelled()} to return true. 140 * After invoking this method, {@link #onCancelled(Object)}, instead of 141 * {@link #onPostExecute(Object)} will be invoked after {@link #doInBackground(Object[])} 142 * returns. To ensure that a task is cancelled as quickly as possible, you should always 143 * check the return value of {@link #isCancelled()} periodically from 144 * {@link #doInBackground(Object[])}, if possible (inside a loop for instance.)</p> 145 * 146 * <h2>Threading rules</h2> 147 * <p>There are a few threading rules that must be followed for this class to 148 * work properly:</p> 149 * <ul> 150 * <li>The AsyncTask class must be loaded on the UI thread. This is done 151 * automatically as of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}.</li> 152 * <li>The task instance must be created on the UI thread.</li> 153 * <li>{@link #execute} must be invoked on the UI thread.</li> 154 * <li>Do not call {@link #onPreExecute()}, {@link #onPostExecute}, 155 * {@link #doInBackground}, {@link #onProgressUpdate} manually.</li> 156 * <li>The task can be executed only once (an exception will be thrown if 157 * a second execution is attempted.)</li> 158 * </ul> 159 * 160 * <h2>Memory observability</h2> 161 * <p>AsyncTask guarantees that all callback calls are synchronized in such a way that the following 162 * operations are safe without explicit synchronizations.</p> 163 * <ul> 164 * <li>Set member fields in the constructor or {@link #onPreExecute}, and refer to them 165 * in {@link #doInBackground}. 166 * <li>Set member fields in {@link #doInBackground}, and refer to them in 167 * {@link #onProgressUpdate} and {@link #onPostExecute}. 168 * </ul> 169 * 170 * <h2>Order of execution</h2> 171 * <p>When first introduced, AsyncTasks were executed serially on a single background 172 * thread. Starting with {@link android.os.Build.VERSION_CODES#DONUT}, this was changed 173 * to a pool of threads allowing multiple tasks to operate in parallel. Starting with 174 * {@link android.os.Build.VERSION_CODES#HONEYCOMB}, tasks are executed on a single 175 * thread to avoid common application errors caused by parallel execution.</p> 176 * <p>If you truly want parallel execution, you can invoke 177 * {@link #executeOnExecutor(java.util.concurrent.Executor, Object[])} with 178 * {@link #THREAD_POOL_EXECUTOR}.</p> 179 */ 180 public abstract class AsyncTask<Params, Progress, Result> { 181 private static final String LOG_TAG = "AsyncTask"; 182 183 private static final int CPU_COUNT = Runtime.getRuntime().availableProcessors(); 184 // We want at least 2 threads and at most 4 threads in the core pool, 185 // preferring to have 1 less than the CPU count to avoid saturating 186 // the CPU with background work 187 private static final int CORE_POOL_SIZE = Math.max(2, Math.min(CPU_COUNT - 1, 4)); 188 private static final int MAXIMUM_POOL_SIZE = CPU_COUNT * 2 + 1; 189 private static final int KEEP_ALIVE_SECONDS = 30; 190 191 private static final ThreadFactory sThreadFactory = new ThreadFactory() { 192 private final AtomicInteger mCount = new AtomicInteger(1); 193 194 public Thread newThread(Runnable r) { 195 return new Thread(r, "AsyncTask #" + mCount.getAndIncrement()); 196 } 197 }; 198 199 private static final BlockingQueue<Runnable> sPoolWorkQueue = 200 new LinkedBlockingQueue<Runnable>(128); 201 202 /** 203 * An {@link Executor} that can be used to execute tasks in parallel. 204 */ 205 public static final Executor THREAD_POOL_EXECUTOR; 206 207 static { 208 ThreadPoolExecutor threadPoolExecutor = new ThreadPoolExecutor( 209 CORE_POOL_SIZE, MAXIMUM_POOL_SIZE, KEEP_ALIVE_SECONDS, TimeUnit.SECONDS, 210 sPoolWorkQueue, sThreadFactory); 211 threadPoolExecutor.allowCoreThreadTimeOut(true); 212 THREAD_POOL_EXECUTOR = threadPoolExecutor; 213 } 214 215 /** 216 * An {@link Executor} that executes tasks one at a time in serial 217 * order. This serialization is global to a particular process. 218 */ 219 public static final Executor SERIAL_EXECUTOR = new SerialExecutor(); 220 221 private static final int MESSAGE_POST_RESULT = 0x1; 222 private static final int MESSAGE_POST_PROGRESS = 0x2; 223 224 private static volatile Executor sDefaultExecutor = SERIAL_EXECUTOR; 225 private static InternalHandler sHandler; 226 227 private final WorkerRunnable<Params, Result> mWorker; 228 private final FutureTask<Result> mFuture; 229 230 private volatile Status mStatus = Status.PENDING; 231 232 private final AtomicBoolean mCancelled = new AtomicBoolean(); 233 private final AtomicBoolean mTaskInvoked = new AtomicBoolean(); 234 235 private static class SerialExecutor implements Executor { 236 final ArrayDeque<Runnable> mTasks = new ArrayDeque<Runnable>(); 237 Runnable mActive; 238 execute(final Runnable r)239 public synchronized void execute(final Runnable r) { 240 mTasks.offer(new Runnable() { 241 public void run() { 242 try { 243 r.run(); 244 } finally { 245 scheduleNext(); 246 } 247 } 248 }); 249 if (mActive == null) { 250 scheduleNext(); 251 } 252 } 253 scheduleNext()254 protected synchronized void scheduleNext() { 255 if ((mActive = mTasks.poll()) != null) { 256 THREAD_POOL_EXECUTOR.execute(mActive); 257 } 258 } 259 } 260 261 /** 262 * Indicates the current status of the task. Each status will be set only once 263 * during the lifetime of a task. 264 */ 265 public enum Status { 266 /** 267 * Indicates that the task has not been executed yet. 268 */ 269 PENDING, 270 /** 271 * Indicates that the task is running. 272 */ 273 RUNNING, 274 /** 275 * Indicates that {@link AsyncTask#onPostExecute} has finished. 276 */ 277 FINISHED, 278 } 279 getHandler()280 private static Handler getHandler() { 281 synchronized (AsyncTask.class) { 282 if (sHandler == null) { 283 sHandler = new InternalHandler(); 284 } 285 return sHandler; 286 } 287 } 288 289 /** @hide */ setDefaultExecutor(Executor exec)290 public static void setDefaultExecutor(Executor exec) { 291 sDefaultExecutor = exec; 292 } 293 294 /** 295 * Creates a new asynchronous task. This constructor must be invoked on the UI thread. 296 */ AsyncTask()297 public AsyncTask() { 298 mWorker = new WorkerRunnable<Params, Result>() { 299 public Result call() throws Exception { 300 mTaskInvoked.set(true); 301 Result result = null; 302 try { 303 Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND); 304 //noinspection unchecked 305 result = doInBackground(mParams); 306 Binder.flushPendingCommands(); 307 } catch (Throwable tr) { 308 mCancelled.set(true); 309 throw tr; 310 } finally { 311 postResult(result); 312 } 313 return result; 314 } 315 }; 316 317 mFuture = new FutureTask<Result>(mWorker) { 318 @Override 319 protected void done() { 320 try { 321 postResultIfNotInvoked(get()); 322 } catch (InterruptedException e) { 323 android.util.Log.w(LOG_TAG, e); 324 } catch (ExecutionException e) { 325 throw new RuntimeException("An error occurred while executing doInBackground()", 326 e.getCause()); 327 } catch (CancellationException e) { 328 postResultIfNotInvoked(null); 329 } 330 } 331 }; 332 } 333 postResultIfNotInvoked(Result result)334 private void postResultIfNotInvoked(Result result) { 335 final boolean wasTaskInvoked = mTaskInvoked.get(); 336 if (!wasTaskInvoked) { 337 postResult(result); 338 } 339 } 340 postResult(Result result)341 private Result postResult(Result result) { 342 @SuppressWarnings("unchecked") 343 Message message = getHandler().obtainMessage(MESSAGE_POST_RESULT, 344 new AsyncTaskResult<Result>(this, result)); 345 message.sendToTarget(); 346 return result; 347 } 348 349 /** 350 * Returns the current status of this task. 351 * 352 * @return The current status. 353 */ getStatus()354 public final Status getStatus() { 355 return mStatus; 356 } 357 358 /** 359 * Override this method to perform a computation on a background thread. The 360 * specified parameters are the parameters passed to {@link #execute} 361 * by the caller of this task. 362 * 363 * This method can call {@link #publishProgress} to publish updates 364 * on the UI thread. 365 * 366 * @param params The parameters of the task. 367 * 368 * @return A result, defined by the subclass of this task. 369 * 370 * @see #onPreExecute() 371 * @see #onPostExecute 372 * @see #publishProgress 373 */ 374 @WorkerThread doInBackground(Params... params)375 protected abstract Result doInBackground(Params... params); 376 377 /** 378 * Runs on the UI thread before {@link #doInBackground}. 379 * 380 * @see #onPostExecute 381 * @see #doInBackground 382 */ 383 @MainThread onPreExecute()384 protected void onPreExecute() { 385 } 386 387 /** 388 * <p>Runs on the UI thread after {@link #doInBackground}. The 389 * specified result is the value returned by {@link #doInBackground}.</p> 390 * 391 * <p>This method won't be invoked if the task was cancelled.</p> 392 * 393 * @param result The result of the operation computed by {@link #doInBackground}. 394 * 395 * @see #onPreExecute 396 * @see #doInBackground 397 * @see #onCancelled(Object) 398 */ 399 @SuppressWarnings({"UnusedDeclaration"}) 400 @MainThread onPostExecute(Result result)401 protected void onPostExecute(Result result) { 402 } 403 404 /** 405 * Runs on the UI thread after {@link #publishProgress} is invoked. 406 * The specified values are the values passed to {@link #publishProgress}. 407 * 408 * @param values The values indicating progress. 409 * 410 * @see #publishProgress 411 * @see #doInBackground 412 */ 413 @SuppressWarnings({"UnusedDeclaration"}) 414 @MainThread onProgressUpdate(Progress... values)415 protected void onProgressUpdate(Progress... values) { 416 } 417 418 /** 419 * <p>Runs on the UI thread after {@link #cancel(boolean)} is invoked and 420 * {@link #doInBackground(Object[])} has finished.</p> 421 * 422 * <p>The default implementation simply invokes {@link #onCancelled()} and 423 * ignores the result. If you write your own implementation, do not call 424 * <code>super.onCancelled(result)</code>.</p> 425 * 426 * @param result The result, if any, computed in 427 * {@link #doInBackground(Object[])}, can be null 428 * 429 * @see #cancel(boolean) 430 * @see #isCancelled() 431 */ 432 @SuppressWarnings({"UnusedParameters"}) 433 @MainThread onCancelled(Result result)434 protected void onCancelled(Result result) { 435 onCancelled(); 436 } 437 438 /** 439 * <p>Applications should preferably override {@link #onCancelled(Object)}. 440 * This method is invoked by the default implementation of 441 * {@link #onCancelled(Object)}.</p> 442 * 443 * <p>Runs on the UI thread after {@link #cancel(boolean)} is invoked and 444 * {@link #doInBackground(Object[])} has finished.</p> 445 * 446 * @see #onCancelled(Object) 447 * @see #cancel(boolean) 448 * @see #isCancelled() 449 */ 450 @MainThread onCancelled()451 protected void onCancelled() { 452 } 453 454 /** 455 * Returns <tt>true</tt> if this task was cancelled before it completed 456 * normally. If you are calling {@link #cancel(boolean)} on the task, 457 * the value returned by this method should be checked periodically from 458 * {@link #doInBackground(Object[])} to end the task as soon as possible. 459 * 460 * @return <tt>true</tt> if task was cancelled before it completed 461 * 462 * @see #cancel(boolean) 463 */ isCancelled()464 public final boolean isCancelled() { 465 return mCancelled.get(); 466 } 467 468 /** 469 * <p>Attempts to cancel execution of this task. This attempt will 470 * fail if the task has already completed, already been cancelled, 471 * or could not be cancelled for some other reason. If successful, 472 * and this task has not started when <tt>cancel</tt> is called, 473 * this task should never run. If the task has already started, 474 * then the <tt>mayInterruptIfRunning</tt> parameter determines 475 * whether the thread executing this task should be interrupted in 476 * an attempt to stop the task.</p> 477 * 478 * <p>Calling this method will result in {@link #onCancelled(Object)} being 479 * invoked on the UI thread after {@link #doInBackground(Object[])} 480 * returns. Calling this method guarantees that {@link #onPostExecute(Object)} 481 * is never invoked. After invoking this method, you should check the 482 * value returned by {@link #isCancelled()} periodically from 483 * {@link #doInBackground(Object[])} to finish the task as early as 484 * possible.</p> 485 * 486 * @param mayInterruptIfRunning <tt>true</tt> if the thread executing this 487 * task should be interrupted; otherwise, in-progress tasks are allowed 488 * to complete. 489 * 490 * @return <tt>false</tt> if the task could not be cancelled, 491 * typically because it has already completed normally; 492 * <tt>true</tt> otherwise 493 * 494 * @see #isCancelled() 495 * @see #onCancelled(Object) 496 */ cancel(boolean mayInterruptIfRunning)497 public final boolean cancel(boolean mayInterruptIfRunning) { 498 mCancelled.set(true); 499 return mFuture.cancel(mayInterruptIfRunning); 500 } 501 502 /** 503 * Waits if necessary for the computation to complete, and then 504 * retrieves its result. 505 * 506 * @return The computed result. 507 * 508 * @throws CancellationException If the computation was cancelled. 509 * @throws ExecutionException If the computation threw an exception. 510 * @throws InterruptedException If the current thread was interrupted 511 * while waiting. 512 */ get()513 public final Result get() throws InterruptedException, ExecutionException { 514 return mFuture.get(); 515 } 516 517 /** 518 * Waits if necessary for at most the given time for the computation 519 * to complete, and then retrieves its result. 520 * 521 * @param timeout Time to wait before cancelling the operation. 522 * @param unit The time unit for the timeout. 523 * 524 * @return The computed result. 525 * 526 * @throws CancellationException If the computation was cancelled. 527 * @throws ExecutionException If the computation threw an exception. 528 * @throws InterruptedException If the current thread was interrupted 529 * while waiting. 530 * @throws TimeoutException If the wait timed out. 531 */ get(long timeout, TimeUnit unit)532 public final Result get(long timeout, TimeUnit unit) throws InterruptedException, 533 ExecutionException, TimeoutException { 534 return mFuture.get(timeout, unit); 535 } 536 537 /** 538 * Executes the task with the specified parameters. The task returns 539 * itself (this) so that the caller can keep a reference to it. 540 * 541 * <p>Note: this function schedules the task on a queue for a single background 542 * thread or pool of threads depending on the platform version. When first 543 * introduced, AsyncTasks were executed serially on a single background thread. 544 * Starting with {@link android.os.Build.VERSION_CODES#DONUT}, this was changed 545 * to a pool of threads allowing multiple tasks to operate in parallel. Starting 546 * {@link android.os.Build.VERSION_CODES#HONEYCOMB}, tasks are back to being 547 * executed on a single thread to avoid common application errors caused 548 * by parallel execution. If you truly want parallel execution, you can use 549 * the {@link #executeOnExecutor} version of this method 550 * with {@link #THREAD_POOL_EXECUTOR}; however, see commentary there for warnings 551 * on its use. 552 * 553 * <p>This method must be invoked on the UI thread. 554 * 555 * @param params The parameters of the task. 556 * 557 * @return This instance of AsyncTask. 558 * 559 * @throws IllegalStateException If {@link #getStatus()} returns either 560 * {@link AsyncTask.Status#RUNNING} or {@link AsyncTask.Status#FINISHED}. 561 * 562 * @see #executeOnExecutor(java.util.concurrent.Executor, Object[]) 563 * @see #execute(Runnable) 564 */ 565 @MainThread execute(Params... params)566 public final AsyncTask<Params, Progress, Result> execute(Params... params) { 567 return executeOnExecutor(sDefaultExecutor, params); 568 } 569 570 /** 571 * Executes the task with the specified parameters. The task returns 572 * itself (this) so that the caller can keep a reference to it. 573 * 574 * <p>This method is typically used with {@link #THREAD_POOL_EXECUTOR} to 575 * allow multiple tasks to run in parallel on a pool of threads managed by 576 * AsyncTask, however you can also use your own {@link Executor} for custom 577 * behavior. 578 * 579 * <p><em>Warning:</em> Allowing multiple tasks to run in parallel from 580 * a thread pool is generally <em>not</em> what one wants, because the order 581 * of their operation is not defined. For example, if these tasks are used 582 * to modify any state in common (such as writing a file due to a button click), 583 * there are no guarantees on the order of the modifications. 584 * Without careful work it is possible in rare cases for the newer version 585 * of the data to be over-written by an older one, leading to obscure data 586 * loss and stability issues. Such changes are best 587 * executed in serial; to guarantee such work is serialized regardless of 588 * platform version you can use this function with {@link #SERIAL_EXECUTOR}. 589 * 590 * <p>This method must be invoked on the UI thread. 591 * 592 * @param exec The executor to use. {@link #THREAD_POOL_EXECUTOR} is available as a 593 * convenient process-wide thread pool for tasks that are loosely coupled. 594 * @param params The parameters of the task. 595 * 596 * @return This instance of AsyncTask. 597 * 598 * @throws IllegalStateException If {@link #getStatus()} returns either 599 * {@link AsyncTask.Status#RUNNING} or {@link AsyncTask.Status#FINISHED}. 600 * 601 * @see #execute(Object[]) 602 */ 603 @MainThread executeOnExecutor(Executor exec, Params... params)604 public final AsyncTask<Params, Progress, Result> executeOnExecutor(Executor exec, 605 Params... params) { 606 if (mStatus != Status.PENDING) { 607 switch (mStatus) { 608 case RUNNING: 609 throw new IllegalStateException("Cannot execute task:" 610 + " the task is already running."); 611 case FINISHED: 612 throw new IllegalStateException("Cannot execute task:" 613 + " the task has already been executed " 614 + "(a task can be executed only once)"); 615 } 616 } 617 618 mStatus = Status.RUNNING; 619 620 onPreExecute(); 621 622 mWorker.mParams = params; 623 exec.execute(mFuture); 624 625 return this; 626 } 627 628 /** 629 * Convenience version of {@link #execute(Object...)} for use with 630 * a simple Runnable object. See {@link #execute(Object[])} for more 631 * information on the order of execution. 632 * 633 * @see #execute(Object[]) 634 * @see #executeOnExecutor(java.util.concurrent.Executor, Object[]) 635 */ 636 @MainThread execute(Runnable runnable)637 public static void execute(Runnable runnable) { 638 sDefaultExecutor.execute(runnable); 639 } 640 641 /** 642 * This method can be invoked from {@link #doInBackground} to 643 * publish updates on the UI thread while the background computation is 644 * still running. Each call to this method will trigger the execution of 645 * {@link #onProgressUpdate} on the UI thread. 646 * 647 * {@link #onProgressUpdate} will not be called if the task has been 648 * canceled. 649 * 650 * @param values The progress values to update the UI with. 651 * 652 * @see #onProgressUpdate 653 * @see #doInBackground 654 */ 655 @WorkerThread publishProgress(Progress... values)656 protected final void publishProgress(Progress... values) { 657 if (!isCancelled()) { 658 getHandler().obtainMessage(MESSAGE_POST_PROGRESS, 659 new AsyncTaskResult<Progress>(this, values)).sendToTarget(); 660 } 661 } 662 finish(Result result)663 private void finish(Result result) { 664 if (isCancelled()) { 665 onCancelled(result); 666 } else { 667 onPostExecute(result); 668 } 669 mStatus = Status.FINISHED; 670 } 671 672 private static class InternalHandler extends Handler { InternalHandler()673 public InternalHandler() { 674 super(Looper.getMainLooper()); 675 } 676 677 @SuppressWarnings({"unchecked", "RawUseOfParameterizedType"}) 678 @Override handleMessage(Message msg)679 public void handleMessage(Message msg) { 680 AsyncTaskResult<?> result = (AsyncTaskResult<?>) msg.obj; 681 switch (msg.what) { 682 case MESSAGE_POST_RESULT: 683 // There is only one result 684 result.mTask.finish(result.mData[0]); 685 break; 686 case MESSAGE_POST_PROGRESS: 687 result.mTask.onProgressUpdate(result.mData); 688 break; 689 } 690 } 691 } 692 693 private static abstract class WorkerRunnable<Params, Result> implements Callable<Result> { 694 Params[] mParams; 695 } 696 697 @SuppressWarnings({"RawUseOfParameterizedType"}) 698 private static class AsyncTaskResult<Data> { 699 final AsyncTask mTask; 700 final Data[] mData; 701 AsyncTaskResult(AsyncTask task, Data... data)702 AsyncTaskResult(AsyncTask task, Data... data) { 703 mTask = task; 704 mData = data; 705 } 706 } 707 } 708