From 0cd36a6e3bfda1c8b78c0375225929f50ee408a5 Mon Sep 17 00:00:00 2001 From: zachh Date: Tue, 31 Oct 2017 12:04:05 -0700 Subject: Removed helper methods in DialerExecutors. We now use dagger everywhere for consistency and explicitness. Test: tap PiperOrigin-RevId: 174071122 Change-Id: I15d2f8261a7b753353be9e7d3b80692aa0c1b64d --- .../dialer/common/concurrent/DialerExecutor.java | 90 ++++++++++++++- .../dialer/common/concurrent/DialerExecutors.java | 122 +-------------------- 2 files changed, 90 insertions(+), 122 deletions(-) (limited to 'java/com/android/dialer/common') diff --git a/java/com/android/dialer/common/concurrent/DialerExecutor.java b/java/com/android/dialer/common/concurrent/DialerExecutor.java index 0414581d4..3ee06445f 100644 --- a/java/com/android/dialer/common/concurrent/DialerExecutor.java +++ b/java/com/android/dialer/common/concurrent/DialerExecutor.java @@ -25,7 +25,95 @@ import java.util.concurrent.ExecutorService; /** * Provides a consistent interface for doing background work in either UI or non-UI contexts. * - *

See {@link DialerExecutors} for usage examples. + *

You may create an executor from a UI component (activity or fragment) or a non-UI component. + * Using this class provides a number of benefits: + * + *

+ * + *

Executors accept a single input and output parameter which should be immutable data objects. + * If you don't require an input or output, use Void and null as needed. + * + *

You may optionally specify onSuccess and onFailure listeners; the default behavior on success + * is a no-op and the default behavior on failure is to crash the application. + * + *

To use an executor from a UI component, you must create it in your onCreate method and then + * use it from anywhere: + * + * 


+ *
+ * public class MyActivity extends Activity {
+ *
+ *   private final DialerExecutor<MyInputType> myExecutor;
+ *
+ *   public void onCreate(Bundle state) {
+ *     super.onCreate(bundle);
+ *
+ *     // Must be called in onCreate; don't use non-static or anonymous inner classes for worker!
+ *     myExecutor = DialerExecutorComponent.get(context).dialerExecutorFactory()
+ *         .createUiTaskBuilder(fragmentManager, taskId, worker)
+ *         .onSuccess(this::onSuccess)  // Lambdas, anonymous, or non-static inner classes all fine
+ *         .onFailure(this::onFailure)  // Lambdas, anonymous, or non-static inner classes all fine
+ *         .build();
+ *     );
+ *   }
+ *
+ *   private static class MyWorker implements Worker<MyInputType, MyOutputType> {
+ *     MyOutputType doInBackground(MyInputType input) { ... }
+ *   }
+ *   private void onSuccess(MyOutputType output) { ... }
+ *   private void onFailure(Throwable throwable) { ... }
+ *
+ *   private void userDidSomething() { myExecutor.executeParallel(input); }
+ * }
+ *
+ * + *

Usage for non-UI tasks is the same, except that tasks can be created from anywhere instead of + * in onCreate. Non-UI tasks use low-priority threads separate from the UI task threads so as not to + * compete with more critical UI tasks. + * + * 


+ *
+ * public class MyManager {
+ *
+ *   private final DialerExecutor<MyInputType> myExecutor;
+ *
+ *   public void init() {
+ *     // Don't use non-static or anonymous inner classes for worker!
+ *     myExecutor = DialerExecutorComponent.get(context).dialerExecutorFactory()
+ *         .createNonUiTaskBuilder(worker)
+ *         .onSuccess(this::onSuccess)  // Lambdas, anonymous, or non-static inner classes all fine
+ *         .onFailure(this::onFailure)  // Lambdas, anonymous, or non-static inner classes all fine
+ *         .build();
+ *     );
+ *   }
+ *
+ *   private static class MyWorker implements Worker<MyInputType, MyOutputType> {
+ *     MyOutputType doInBackground(MyInputType input) { ... }
+ *   }
+ *   private void onSuccess(MyOutputType output) { ... }
+ *   private void onFailure(Throwable throwable) { ... }
+ *
+ *   private void userDidSomething() { myExecutor.executeParallel(input); }
+ * }
+ *
+ * + * Note that non-UI tasks are intended to be relatively quick; for example reading/writing shared + * preferences or doing simple database work. If you submit long running non-UI tasks you may + * saturate the shared application threads and block other tasks. Also, this class does not create + * any wakelocks, so a long running task could be killed if the device goes to sleep while your task + * is still running. If you have to do long running or periodic work, consider using a job + * scheduler. */ public interface DialerExecutor { diff --git a/java/com/android/dialer/common/concurrent/DialerExecutors.java b/java/com/android/dialer/common/concurrent/DialerExecutors.java index 4d8331fb6..b29bf5d3b 100644 --- a/java/com/android/dialer/common/concurrent/DialerExecutors.java +++ b/java/com/android/dialer/common/concurrent/DialerExecutors.java @@ -16,134 +16,14 @@ package com.android.dialer.common.concurrent; -import android.app.FragmentManager; import android.content.Context; import android.support.annotation.NonNull; import com.android.dialer.common.Assert; -import com.android.dialer.common.concurrent.DialerExecutor.Worker; import java.util.concurrent.ExecutorService; -/** - * Factory methods for creating {@link DialerExecutor} objects for doing background work. - * - *

You may create an executor from a UI component (activity or fragment) or a non-UI component. - * Using this class provides a number of benefits: - * - *

- * - *

Executors accept a single input and output parameter which should be immutable data objects. - * If you don't require an input or output, use Void and null as needed. - * - *

You may optionally specify onSuccess and onFailure listeners; the default behavior on success - * is a no-op and the default behavior on failure is to crash the application. - * - *

To use an executor from a UI component, you must create it in your onCreate method and then - * use it from anywhere: - * - * 


- *
- * public class MyActivity extends Activity {
- *
- *   private final DialerExecutor<MyInputType> myExecutor;
- *
- *   public void onCreate(Bundle state) {
- *     super.onCreate(bundle);
- *
- *     // Must be called in onCreate; don't use non-static or anonymous inner classes for worker!
- *     myExecutor = DialerExecutors.createUiTaskBuilder(fragmentManager, taskId, worker)
- *         .onSuccess(this::onSuccess)  // Lambdas, anonymous, or non-static inner classes all fine
- *         .onFailure(this::onFailure)  // Lambdas, anonymous, or non-static inner classes all fine
- *         .build();
- *     );
- *   }
- *
- *   private static class MyWorker implements Worker<MyInputType, MyOutputType> {
- *     MyOutputType doInBackground(MyInputType input) { ... }
- *   }
- *   private void onSuccess(MyOutputType output) { ... }
- *   private void onFailure(Throwable throwable) { ... }
- *
- *   private void userDidSomething() { myExecutor.executeParallel(input); }
- * }
- *
- * - *

Usage for non-UI tasks is the same, except that tasks can be created from anywhere instead of - * in onCreate. Non-UI tasks use low-priority threads separate from the UI task threads so as not to - * compete with more critical UI tasks. - * - * 


- *
- * public class MyManager {
- *
- *   private final DialerExecutor<MyInputType> myExecutor;
- *
- *   public void init() {
- *     // Don't use non-static or anonymous inner classes for worker!
- *     myExecutor = DialerExecutors.createNonUiTaskBuilder(worker)
- *         .onSuccess(this::onSuccess)  // Lambdas, anonymous, or non-static inner classes all fine
- *         .onFailure(this::onFailure)  // Lambdas, anonymous, or non-static inner classes all fine
- *         .build();
- *     );
- *   }
- *
- *   private static class MyWorker implements Worker<MyInputType, MyOutputType> {
- *     MyOutputType doInBackground(MyInputType input) { ... }
- *   }
- *   private void onSuccess(MyOutputType output) { ... }
- *   private void onFailure(Throwable throwable) { ... }
- *
- *   private void userDidSomething() { myExecutor.executeParallel(input); }
- * }
- *
- * - * Note that non-UI tasks are intended to be relatively quick; for example reading/writing shared - * preferences or doing simple database work. If you submit long running non-UI tasks you may - * saturate the shared application threads and block other tasks. Also, this class does not create - * any wakelocks, so a long running task could be killed if the device goes to sleep while your task - * is still running. If you have to do long running or periodic work, consider using a job - * scheduler. - */ +/** Shared application executors. */ public final class DialerExecutors { - /** - * @param context any valid context object from which the application context can be retrieved - * @see DialerExecutorFactory#createUiTaskBuilder(FragmentManager, String, Worker) - */ - @NonNull - public static DialerExecutor.Builder createUiTaskBuilder( - @NonNull Context context, - @NonNull FragmentManager fragmentManager, - @NonNull String taskId, - @NonNull Worker worker) { - return DialerExecutorComponent.get(Assert.isNotNull(context)) - .dialerExecutorFactory() - .createUiTaskBuilder( - Assert.isNotNull(fragmentManager), Assert.isNotNull(taskId), Assert.isNotNull(worker)); - } - - /** - * @param context any valid context object from which the application context can be retrieved - * @see DialerExecutorFactory#createNonUiTaskBuilder(Worker) - */ - @NonNull - public static DialerExecutor.Builder createNonUiTaskBuilder( - Context context, @NonNull Worker worker) { - return DialerExecutorComponent.get(Assert.isNotNull(context)) - .dialerExecutorFactory() - .createNonUiTaskBuilder(Assert.isNotNull(worker)); - } - /** * An application-wide thread pool used for low priority (non-UI) tasks. * -- cgit v1.2.3