Cleans up and adds javadoc.

Author: Josh Deffibaugh

android-sdk/src/main/java/com/optimizely/ab/android/sdk/BackgroundWatchersCache.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package com.optimizely.ab.android.sdk;
 
 import android.support.annotation.NonNull;
@@ -30,7 +31,7 @@
 import java.util.Iterator;
 import java.util.List;
 
-/**
+/*
  * Caches a json dict that saves state about which project IDs have background watching enabled.
  */
 class BackgroundWatchersCache {

android-sdk/src/main/java/com/optimizely/ab/android/sdk/DataFileCache.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package com.optimizely.ab.android.sdk;
 
 import android.support.annotation.NonNull;
@@ -27,7 +28,7 @@
 import java.io.FileNotFoundException;
 import java.io.IOException;
 
-/**
+/*
  * Abstracts the actual data "file" {@link java.io.File}
  */
 class DataFileCache {

android-sdk/src/main/java/com/optimizely/ab/android/sdk/DataFileClient.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package com.optimizely.ab.android.sdk;
 
 import android.support.annotation.NonNull;
@@ -25,7 +26,7 @@
 import java.net.HttpURLConnection;
 import java.net.URL;
 
-/**
+/*
  * Makes requests to the Optly CDN to get the data file
  */
 class DataFileClient {

android-sdk/src/main/java/com/optimizely/ab/android/sdk/DataFileLoadedListener.java

@@ -13,9 +13,21 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package com.optimizely.ab.android.sdk;
 
+/**
+ * Listens for new Optimizely datafiles
+ *
+ * @hide
+ */
 interface DataFileLoadedListener {
 
+    /**
+     * Called with new datafile
+     *
+     * @param dataFile the datafile json
+     * @hide
+     */
     void onDataFileLoaded(String dataFile);
 }

android-sdk/src/main/java/com/optimizely/ab/android/sdk/DataFileLoader.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package com.optimizely.ab.android.sdk;
 
 import android.os.AsyncTask;
@@ -30,7 +31,7 @@
 import java.util.concurrent.Executor;
 import java.util.concurrent.Executors;
 
-/**
+/*
  * Handles intents and bindings in {@link DataFileService}
  */
 class DataFileLoader {

android-sdk/src/main/java/com/optimizely/ab/android/sdk/DataFileRescheduler.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package com.optimizely.ab.android.sdk;
 
 import android.content.BroadcastReceiver;
@@ -27,6 +28,12 @@
 
 import java.util.List;
 
+/**
+ * Broadcast Receiver that handles app upgrade and phone restart broadcasts in order
+ * to reschedule {@link DataFileService}
+ *
+ * @hide
+ */
 public class DataFileRescheduler extends BroadcastReceiver {
     Logger logger = LoggerFactory.getLogger(DataFileRescheduler.class);
 
@@ -49,7 +56,7 @@ public void onReceive(Context context, Intent intent) {
         }
     }
 
-    /**
+    /*
      * Handles building sending Intents to {@link DataFileService}
      *
      * This abstraction mostly makes unit testing easier

android-sdk/src/main/java/com/optimizely/ab/android/sdk/DataFileService.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package com.optimizely.ab.android.sdk;
 
 import android.app.Service;
@@ -26,12 +27,21 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * Service that handles loading the datafile from cache or downloads it from the CDN
+ *
+ * @hide
+ */
 public class DataFileService extends Service {
-    public static final String EXTRA_PROJECT_ID = "com.optimizely.ab.android.EXTRA_PROJECT_ID";
+    static final String EXTRA_PROJECT_ID = "com.optimizely.ab.android.EXTRA_PROJECT_ID";
     @NonNull private final IBinder binder = new LocalBinder();
     Logger logger = LoggerFactory.getLogger(getClass());
     private boolean isBound;
 
+    /**
+     * @hide
+     * @see Service#onStartCommand(Intent, int, int)
+     */
     @Override
     public int onStartCommand(Intent intent, int flags, int startId) {
         if (intent != null) {
@@ -54,12 +64,20 @@ public int onStartCommand(Intent intent, int flags, int startId) {
         return super.onStartCommand(intent, flags, startId);
     }
 
+    /**
+     * @hide
+     * @see Service#onBind(Intent)
+     */
     @Override
     public IBinder onBind(Intent intent) {
         isBound = true;
         return binder;
     }
 
+    /**
+     * @hide
+     * @see Service#onUnbind(Intent)
+     */
     @Override
     public boolean onUnbind(Intent intent) {
         isBound = false;
@@ -80,7 +98,7 @@ void getDataFile(String projectId, DataFileLoader dataFileLoader, DataFileLoaded
     }
 
     class LocalBinder extends Binder {
-        public DataFileService getService() {
+        DataFileService getService() {
             // Return this instance of LocalService so clients can call public methods
             return DataFileService.this;
         }