Add tests and more documentation

Author: bleroux

shell/platform/android/io/flutter/embedding/engine/systemchannels/ProcessTextChannel.java

@@ -20,15 +20,15 @@
  *
  * <p>When there is new a text context menu to display, the framework will send to the embedding the
  * message {@code ProcessText.queryTextActions}. In response, the {@link
- * io.flutter.plugin.text.ProcessTextPlugin} will return a map of all activities that can be performed
- * to process text. The map keys are generated IDs and the values are the activities labels.
- * On the first request, the {@link io.flutter.plugin.text.ProcessTextPlugin} will make a call to
- * Android's package manager to query all activities that can be performed for the
- * {@code Intent.ACTION_PROCESS_TEXT} intent.
+ * io.flutter.plugin.text.ProcessTextPlugin} will return a map of all activities that can be
+ * performed to process text. The map keys are generated IDs and the values are the activities
+ * labels. On the first request, the {@link io.flutter.plugin.text.ProcessTextPlugin} will make a
+ * call to Android's package manager to query all activities that can be performed for the {@code
+ * Intent.ACTION_PROCESS_TEXT} intent.
  *
- * <p>When an text processing action has to be executed, the framework will send to the embedding the
- * message {@code ProcessText.processTextAction} with the {@code int id} of the choosen text action and the
- * {@code String} of text to process as arguments. In response, the {@link
+ * <p>When an text processing action has to be executed, the framework will send to the embedding
+ * the message {@code ProcessText.processTextAction} with the {@code int id} of the choosen text
+ * action and the {@code String} of text to process as arguments. In response, the {@link
  * io.flutter.plugin.text.ProcessTextPlugin} will make a call to the Android application activity to
  * start the activity exposing the text action and it will return the processed text, or null if the
  * activity did not return a value.
@@ -107,7 +107,12 @@ public interface ProcessTextMethodHandler {
     /**
      * Requests to run a text action on a given input text.
      *
-     * <p>TODO(bleroux): add documentation for parameters.
+     * @param id The ID of the text action returned by queryTextActions.
+     * @param input The text to be processed.
+     * @param readOnly Indicates to the activity if the processed text will be used as read-only.
+     *     see
+     *     https://developer.android.com/reference/android/content/Intent#EXTRA_PROCESS_TEXT_READONLY
+     * @param result The method channel result instance used to reply.
      */
     void processTextAction(
         @NonNull int id,

shell/platform/android/io/flutter/plugin/text/ProcessTextPlugin.java

@@ -4,13 +4,15 @@
 
 package io.flutter.plugin.text;
 
+import android.annotation.TargetApi;
 import android.app.Activity;
 import android.content.Intent;
 import android.content.pm.PackageManager;
 import android.content.pm.ResolveInfo;
 import android.os.Build;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.annotation.RequiresApi;
 import io.flutter.embedding.engine.plugins.FlutterPlugin;
 import io.flutter.embedding.engine.plugins.activity.ActivityAware;
 import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding;
@@ -21,7 +23,11 @@
 import java.util.List;
 import java.util.Map;
 
-public class ProcessTextPlugin implements FlutterPlugin, ActivityAware, ActivityResultListener {
+public class ProcessTextPlugin
+    implements FlutterPlugin,
+        ActivityAware,
+        ActivityResultListener,
+        ProcessTextChannel.ProcessTextMethodHandler {
   private static final String TAG = "ProcessTextPlugin";
 
   @NonNull private final ProcessTextChannel processTextChannel;
@@ -37,65 +43,63 @@ public ProcessTextPlugin(@NonNull ProcessTextChannel processTextChannel) {
     this.processTextChannel = processTextChannel;
     this.packageManager = processTextChannel.packageManager;
 
-    processTextChannel.setMethodHandler(
-        new ProcessTextChannel.ProcessTextMethodHandler() {
-          @Override
-          public Map<Integer, String> queryTextActions() {
-            if (resolveInfosById == null) {
-              resolveInfosById = new HashMap<Integer, ResolveInfo>();
-              cacheResolveInfos();
-            }
-            Map<Integer, String> result = new HashMap<Integer, String>();
-            for (Integer id : resolveInfosById.keySet()) {
-              final ResolveInfo info = resolveInfosById.get(id);
-              result.put(id, info.loadLabel(packageManager).toString());
-            }
-            return result;
-          }
-
-          @Override
-          public void processTextAction(
-              @NonNull int id,
-              @NonNull String text,
-              @NonNull boolean readOnly,
-              @NonNull MethodChannel.Result result) {
-            if (activityBinding == null) {
-              result.error("error", "Plugin not bound to an Activity", null);
-              return;
-            }
-
-            if (Build.VERSION.SDK_INT < Build.VERSION_CODES.M) {
-              result.error("error", "Android version not supported", null);
-              return;
-            }
-
-            if (resolveInfosById == null) {
-              result.error("error", "Can not process text actions before calling queryTextActions", null);
-              return;
-            }
-
-            final ResolveInfo info = resolveInfosById.get(id);
-            if (info == null) {
-              result.error("error", "Text processing activity not found", null);
-              return;
-            }
-
-            Integer requestCode = result.hashCode();
-            requestsByCode.put(requestCode, result);
-
-            Intent intent =
-                new Intent()
-                    .setClassName(info.activityInfo.packageName, info.activityInfo.name)
-                    .setAction(Intent.ACTION_PROCESS_TEXT)
-                    .setType("text/plain")
-                    .putExtra(Intent.EXTRA_PROCESS_TEXT, text)
-                    .putExtra(Intent.EXTRA_PROCESS_TEXT_READONLY, readOnly);
-
-            // Start the text processing activity. onActivityResult callback is called
-            // when the activity completes.
-            activityBinding.getActivity().startActivityForResult(intent, requestCode);
-          }
-        });
+    processTextChannel.setMethodHandler(this);
+  }
+
+  @Override
+  public Map<Integer, String> queryTextActions() {
+    if (resolveInfosById == null) {
+      resolveInfosById = new HashMap<Integer, ResolveInfo>();
+      cacheResolveInfos();
+    }
+    Map<Integer, String> result = new HashMap<Integer, String>();
+    for (Integer id : resolveInfosById.keySet()) {
+      final ResolveInfo info = resolveInfosById.get(id);
+      result.put(id, info.loadLabel(packageManager).toString());
+    }
+    return result;
+  }
+
+  @Override
+  public void processTextAction(
+      @NonNull int id,
+      @NonNull String text,
+      @NonNull boolean readOnly,
+      @NonNull MethodChannel.Result result) {
+    if (activityBinding == null) {
+      result.error("error", "Plugin not bound to an Activity", null);
+      return;
+    }
+
+    if (Build.VERSION.SDK_INT < Build.VERSION_CODES.M) {
+      result.error("error", "Android version not supported", null);
+      return;
+    }
+
+    if (resolveInfosById == null) {
+      result.error("error", "Can not process text actions before calling queryTextActions", null);
+      return;
+    }
+
+    final ResolveInfo info = resolveInfosById.get(id);
+    if (info == null) {
+      result.error("error", "Text processing activity not found", null);
+      return;
+    }
+
+    Integer requestCode = result.hashCode();
+    requestsByCode.put(requestCode, result);
+
+    Intent intent = new Intent();
+    intent.setClassName(info.activityInfo.packageName, info.activityInfo.name);
+    intent.setAction(Intent.ACTION_PROCESS_TEXT);
+    intent.setType("text/plain");
+    intent.putExtra(Intent.EXTRA_PROCESS_TEXT, text);
+    intent.putExtra(Intent.EXTRA_PROCESS_TEXT_READONLY, readOnly);
+
+    // Start the text processing activity. onActivityResult callback is called
+    // when the activity completes.
+    activityBinding.getActivity().startActivityForResult(intent, requestCode);
   }
 
   private void cacheResolveInfos() {
@@ -126,6 +130,8 @@ private void cacheResolveInfos() {
    *
    * <p>The result is null when an activity does not return an updated text.
    */
+  @TargetApi(Build.VERSION_CODES.M)
+  @RequiresApi(Build.VERSION_CODES.M)
   public boolean onActivityResult(int requestCode, int resultCode, @Nullable Intent intent) {
     String result = null;
     if (resultCode == Activity.RESULT_OK) {