1 files changed, 29 insertions, 0 deletions
diff --git a/mobile/android/geckoview/src/main/java/org/mozilla/gecko/util/EventCallback.java b/mobile/android/geckoview/src/main/java/org/mozilla/gecko/util/EventCallback.java
new file mode 100644
index 000000000..099542666
--- /dev/null
+++ b/mobile/android/geckoview/src/main/java/org/mozilla/gecko/util/EventCallback.java
@@ -0,0 +1,29 @@
+package org.mozilla.gecko.util;
+
+import org.mozilla.gecko.annotation.RobocopTarget;
+
+/**
+ * Callback interface for Gecko requests.
+ *
+ * For each instance of EventCallback, exactly one of sendResponse, sendError, or sendCancel
+ * must be called to prevent observer leaks. If more than one send* method is called, or if a
+ * single send method is called multiple times, an {@link IllegalStateException} will be thrown.
+ */
+@RobocopTarget
+public interface EventCallback {
+    /**
+     * Sends a success response with the given data.
+     *
+     * @param response The response data to send to Gecko. Can be any of the types accepted by
+     *                 JSONObject#put(String, Object).
+     */
+    public void sendSuccess(Object response);
+
+    /**
+     * Sends an error response with the given data.
+     *
+     * @param response The response data to send to Gecko. Can be any of the types accepted by
+     *                 JSONObject#put(String, Object).
+     */
+    public void sendError(Object response);
+}