Merge pull request kaushikgopal#62 from ObjectiveTruth/master

kaushikgopal · web-flow · commit fb5cb289cf90 · 2016-10-08T15:32:56.000-07:00
Added javadoc comments and removed line in the Volley + RxAndroid example
diff --git a/app/src/main/java/com/morihacky/android/rxjava/volley/VolleyDemoFragment.java b/app/src/main/java/com/morihacky/android/rxjava/volley/VolleyDemoFragment.java
@@ -74,6 +74,12 @@ public void onDestroyView() {
         ButterKnife.unbind(this);
     }
 
+    /**
+     * Creates and returns an observable generated from the Future returned from 
+     * {@code getRouteData()}. The observable can then be subscribed to as shown in
+     * {@code startVolleyRequest()}
+     * @return Observable<JSONObject>
+     */
     public Observable<JSONObject> newGetRouteData() {
         return Observable.defer(() -> {
             try {
@@ -119,11 +125,16 @@ public void onNext(JSONObject jsonObject) {
                   }
               }));
     }
-
+    /**
+     * Converts the Asynchronous Request into a Synchronous Future that can be used to
+     * block via {@code Future.get()}. Observables require blocking/synchronous functions
+     * @return JSONObject 
+     * @throws ExecutionException
+     * @throws InterruptedException
+     */
     private JSONObject getRouteData() throws ExecutionException, InterruptedException {
         RequestFuture<JSONObject> future = RequestFuture.newFuture();
         String url = "http://www.weather.com.cn/adat/sk/101010100.html";
-        final Request.Priority priority = Request.Priority.IMMEDIATE;
         JsonObjectRequest req = new JsonObjectRequest(Request.Method.GET, url, future, future);
         MyVolley.getRequestQueue().add(req);
         return future.get();
