Group methods in help() by class. (#57)

Fixes #44.

2 files changed, 26 insertions, 3 deletions

diff --git a/third_party/sl4a/src/main/java/com/google/android/mobly/snippet/rpc/JsonRpcServer.java b/third_party/sl4a/src/main/java/com/google/android/mobly/snippet/rpc/JsonRpcServer.java
index e5a19db..219c471 100644
--- a/third_party/sl4a/src/main/java/com/google/android/mobly/snippet/rpc/JsonRpcServer.java
+++ b/third_party/sl4a/src/main/java/com/google/android/mobly/snippet/rpc/JsonRpcServer.java
@@ -22,7 +22,10 @@ import com.google.android.mobly.snippet.util.Log;
 import java.io.BufferedReader;
 import java.io.PrintWriter;
 import java.net.Socket;
+import java.util.LinkedHashSet;
 import java.util.Map;
+import java.util.Set;
+import java.util.TreeMap;
 import org.json.JSONArray;
 import org.json.JSONException;
 import org.json.JSONObject;
@@ -124,10 +127,25 @@ public class JsonRpcServer extends SimpleServer {
 
     private void help(PrintWriter writer, int id, SnippetManager receiverManager, Integer UID)
             throws JSONException {
-        StringBuilder result = new StringBuilder("Known methods:\n");
+        // Create a map from class simple name to the methods inside it.
+        Map<String, Set<MethodDescriptor>> methods = new TreeMap<>();
         for (String method : receiverManager.getMethodNames()) {
             MethodDescriptor descriptor = receiverManager.getMethodDescriptor(method);
-            result.append("  ").append(descriptor.getHelp()).append("\n");
+            String snippetClassName = descriptor.getSnippetClass().getSimpleName();
+            Set<MethodDescriptor> snippetClassMethods = methods.get(snippetClassName);
+            if (snippetClassMethods == null) {
+                // Preserve insertion order (alphabetical)
+                snippetClassMethods = new LinkedHashSet<>();
+                methods.put(snippetClassName, snippetClassMethods);
+            }
+            snippetClassMethods.add(descriptor);
+        }
+        StringBuilder result = new StringBuilder();
+        for (Map.Entry<String, Set<MethodDescriptor>> entry : methods.entrySet()) {
+            result.append("\nRPCs provided by ").append(entry.getKey()).append(":\n");
+            for (MethodDescriptor descriptor : entry.getValue()) {
+                result.append("  ").append(descriptor.getHelp()).append("\n");
+            }
         }
         send(writer, JsonRpcResult.result(id, result), UID);
     }
diff --git a/third_party/sl4a/src/main/java/com/google/android/mobly/snippet/rpc/MethodDescriptor.java b/third_party/sl4a/src/main/java/com/google/android/mobly/snippet/rpc/MethodDescriptor.java
index 2d822f3..a12716a 100644
--- a/third_party/sl4a/src/main/java/com/google/android/mobly/snippet/rpc/MethodDescriptor.java
+++ b/third_party/sl4a/src/main/java/com/google/android/mobly/snippet/rpc/MethodDescriptor.java
@@ -198,6 +198,10 @@ public final class MethodDescriptor {
         return mMethod.isAnnotationPresent(AsyncRpc.class);
     }
 
+    public Class<? extends Snippet> getSnippetClass() {
+        return mClass;
+    }
+
     private String getAnnotationDescription() {
         if (isAsync()) {
             AsyncRpc annotation = mMethod.getAnnotation(AsyncRpc.class);
@@ -222,7 +226,8 @@ public final class MethodDescriptor {
         }
         String help =
                 String.format(
-                        "%s(%s) returns %s  // %s",
+                        "%s %s(%s) returns %s  // %s",
+                        isAsync() ? "@AsyncRpc" : "@Rpc",
                         mMethod.getName(),
                         paramBuilder,
                         mMethod.getReturnType().getSimpleName(),