Define Events for all Requests to make the events distinguishable

Author: rubengees

library/src/main/java/com/proxerme/library/connection/ProxerConnection.java

@@ -20,6 +20,11 @@
 import com.proxerme.library.entity.LoginData;
 import com.proxerme.library.entity.LoginUser;
 import com.proxerme.library.entity.News;
+import com.proxerme.library.event.ConferencesEvent;
+import com.proxerme.library.event.IEvent;
+import com.proxerme.library.event.LoginEvent;
+import com.proxerme.library.event.LogoutEvent;
+import com.proxerme.library.event.NewsEvent;
 
 import org.json.JSONException;
 import org.json.JSONObject;
@@ -164,35 +169,12 @@ public static void cleanup() {
         Bridge.destroy();
     }
 
-    /**
-     * An abstract representation of a callback, passed to the
-     * {@link ProxerRequest#execute()} method.
-     *
-     * @param <T> The generic parameter.
-     */
-    public interface ResultCallback<T> {
-        /**
-         * A callback method, called if the request was successful.
-         *
-         * @param result The result of the specific request.
-         */
-        void onResult(T result);
-
-        /**
-         * A callback method, called if an error occurred during the request.
-         *
-         * @param exception The Exception that occurred.
-         * @see ProxerException
-         */
-        void onError(@NonNull ProxerException exception);
-    }
-
     /**
      * An abstract representation of a request. All requests to the API are made through this class.
      *
      * @param <T> The type of result, the inheriting request will return.
      */
-    public static abstract class ProxerRequest<T> {
+    public static abstract class ProxerRequest<T, E extends IEvent> {
 
         /**
          * Builds the request, to be used in the
@@ -213,7 +195,8 @@ public static abstract class ProxerRequest<T> {
         protected abstract int getTag();
 
         /**
-         * Asynchronously executes this request.
+         * Asynchronously executes this request. The result will be delivered on the event bus
+         * method.
          *
          * @see #executeSynchronized()
          */
@@ -233,7 +216,7 @@ public void run() {
                                     if (json == null) {
                                         EventBus.getDefault().post(new ProxerException(UNKNOWN));
                                     } else {
-                                        final T result = parse(json);
+                                        final E result = createEvent(parse(json));
 
                                         EventBus.getDefault().post(result);
                                     }
@@ -291,12 +274,14 @@ public final T executeSynchronized() throws ProxerException {
          * @throws JSONException An Exception, which might occur while parsing.
          */
         protected abstract T parse(@NonNull JSONObject response) throws JSONException;
+
+        protected abstract E createEvent(@NonNull T result);
     }
 
     /**
      * A request, returning a List of {@link News}.
      */
-    public static class NewsRequest extends ProxerRequest<List<News>> {
+    public static class NewsRequest extends ProxerRequest<List<News>, NewsEvent> {
 
         private int page;
 
@@ -320,12 +305,17 @@ protected int getTag() {
         protected List<News> parse(@NonNull JSONObject response) throws JSONException {
             return ProxerParser.parseNewsJSON(response);
         }
+
+        @Override
+        protected NewsEvent createEvent(@NonNull List<News> result) {
+            return new NewsEvent(result);
+        }
     }
 
     /**
      * A request for the login, returning a {@link LoginUser} on success.
      */
-    public static class LoginRequest extends ProxerRequest<LoginUser> {
+    public static class LoginRequest extends ProxerRequest<LoginUser, LoginEvent> {
 
         private LoginUser user;
 
@@ -356,12 +346,17 @@ protected LoginUser parse(@NonNull JSONObject response) throws JSONException {
             return new LoginUser(user.getUsername(), user.getPassword(), data.getId(),
                     data.getImageId());
         }
+
+        @Override
+        protected LoginEvent createEvent(@NonNull LoginUser result) {
+            return new LoginEvent(result);
+        }
     }
 
     /**
      * A request for the logout.
      */
-    public static class LogoutRequest extends ProxerRequest<Void> {
+    public static class LogoutRequest extends ProxerRequest<Void, LogoutEvent> {
 
         @NonNull
         @Override
@@ -379,12 +374,17 @@ protected int getTag() {
         protected Void parse(@NonNull JSONObject response) throws JSONException {
             return null;
         }
+
+        @Override
+        protected LogoutEvent createEvent(@NonNull Void result) {
+            return new LogoutEvent();
+        }
     }
 
     /**
      * A request for retrieval of the {@link Conference}s of a user.
      */
-    public static class ConferencesRequest extends ProxerRequest<List<Conference>> {
+    public static class ConferencesRequest extends ProxerRequest<List<Conference>, ConferencesEvent> {
 
         private int page;
 
@@ -407,6 +407,11 @@ protected int getTag() {
         protected List<Conference> parse(@NonNull JSONObject response) throws JSONException {
             return ProxerParser.parseConferencesJSON(response);
         }
+
+        @Override
+        protected ConferencesEvent createEvent(@NonNull List<Conference> result) {
+            return new ConferencesEvent(result);
+        }
     }
 
     private static class ParseThread extends Thread {

library/src/main/java/com/proxerme/library/event/ConferencesEvent.java

@@ -0,0 +1,27 @@
+package com.proxerme.library.event;
+
+import android.support.annotation.NonNull;
+
+import com.proxerme.library.entity.Conference;
+
+import java.util.List;
+
+/**
+ * TODO: Describe Class
+ *
+ * @author Ruben Gees
+ */
+public class ConferencesEvent implements IEvent {
+
+    private List<Conference> conferences;
+
+    public ConferencesEvent(@NonNull List<Conference> conferences) {
+        this.conferences = conferences;
+    }
+
+    @NonNull
+    @Override
+    public Object getItem() {
+        return conferences;
+    }
+}

library/src/main/java/com/proxerme/library/event/IEvent.java

@@ -0,0 +1,14 @@
+package com.proxerme.library.event;
+
+import android.support.annotation.NonNull;
+
+/**
+ * TODO: Describe Class
+ *
+ * @author Ruben Gees
+ */
+public interface IEvent<T> {
+
+    @NonNull
+    T getItem();
+}

library/src/main/java/com/proxerme/library/event/LoginEvent.java

@@ -0,0 +1,25 @@
+package com.proxerme.library.event;
+
+import android.support.annotation.NonNull;
+
+import com.proxerme.library.entity.LoginUser;
+
+/**
+ * TODO: Describe Class
+ *
+ * @author Ruben Gees
+ */
+public class LoginEvent implements IEvent<LoginUser> {
+
+    private LoginUser loginUser;
+
+    public LoginEvent(@NonNull LoginUser loginUser) {
+        this.loginUser = loginUser;
+    }
+
+    @NonNull
+    @Override
+    public LoginUser getItem() {
+        return loginUser;
+    }
+}

library/src/main/java/com/proxerme/library/event/LogoutEvent.java

@@ -0,0 +1,18 @@
+package com.proxerme.library.event;
+
+import android.support.annotation.NonNull;
+
+/**
+ * TODO: Describe Class
+ *
+ * @author Ruben Gees
+ */
+public class LogoutEvent implements IEvent {
+
+    @NonNull
+    @Override
+    public Object getItem() {
+        //noinspection ConstantConditions
+        return null;
+    }
+}

library/src/main/java/com/proxerme/library/event/NewsEvent.java

@@ -0,0 +1,27 @@
+package com.proxerme.library.event;
+
+import android.support.annotation.NonNull;
+
+import com.proxerme.library.entity.News;
+
+import java.util.List;
+
+/**
+ * TODO: Describe Class
+ *
+ * @author Ruben Gees
+ */
+public class NewsEvent implements IEvent<List<News>> {
+
+    private List<News> item;
+
+    public NewsEvent(@NonNull List<News> item) {
+        this.item = item;
+    }
+
+    @Override
+    @NonNull
+    public List<News> getItem() {
+        return item;
+    }
+}