@Nullable/NotNull: Ensure consistency with documentation (#130) (#132)

Author: PLNech

algoliasearch/src/main/java/com/algolia/search/saas/Client.java

@@ -28,6 +28,7 @@
 import android.os.Handler;
 import android.os.Looper;
 import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
 
 import org.json.JSONArray;
 import org.json.JSONException;
@@ -151,7 +152,7 @@ public Client(@NonNull String applicationID, @NonNull String apiKey) {
      * @param apiKey A valid API key for the service.
      * @param hosts An explicit list of hosts to target, or null to use the default hosts.
      */
-    public Client(@NonNull String applicationID, @NonNull String apiKey, String[] hosts) {
+    public Client(@NonNull String applicationID, @NonNull String apiKey, @Nullable String[] hosts) {
         this.applicationID = applicationID;
         this.apiKey = apiKey;
         this.addUserAgent(new LibraryVersion("Algolia for Android", version));
@@ -197,7 +198,7 @@ public String getApplicationID() {
      * @param name  Header name.
      * @param value Value for the header. If null, the header will be removed.
      */
-    public void setHeader(@NonNull String name, String value) {
+    public void setHeader(@NonNull String name, @Nullable String value) {
         if (value == null) {
             headers.remove(name);
         } else {
@@ -916,7 +917,7 @@ protected void onCancelled(APIResult apiResult) {
          *
          * @param completionHandler The completion handler to be notified of results. May be null if the caller omitted it.
          */
-        AsyncTaskRequest(CompletionHandler completionHandler) {
+        AsyncTaskRequest(@Nullable CompletionHandler completionHandler) {
             this(completionHandler, searchExecutorService);
         }
 
@@ -926,7 +927,7 @@ protected void onCancelled(APIResult apiResult) {
          * @param completionHandler The completion handler to be notified of results. May be null if the caller omitted it.
          * @param executorService Executor service on which to execute the request.
          */
-        AsyncTaskRequest(CompletionHandler completionHandler, @NonNull ExecutorService executorService) {
+        AsyncTaskRequest(@Nullable CompletionHandler completionHandler, @NonNull ExecutorService executorService) {
             this.completionHandler = completionHandler;
             this.executorService = executorService;
         }

algoliasearch/src/main/java/com/algolia/search/saas/Index.java

@@ -24,6 +24,7 @@
 package com.algolia.search.saas;
 
 import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
 
 import org.json.JSONArray;
 import org.json.JSONException;
@@ -111,8 +112,8 @@ protected String getEncodedIndexName() {
      * @param completionHandler The listener that will be notified of the request's outcome.
      * @return A cancellable request.
      */
-    public Request searchAsync(@NonNull Query query, @NonNull CompletionHandler completionHandler) {
-        final Query queryCopy = new Query(query);
+    public Request searchAsync(@Nullable Query query, @Nullable CompletionHandler completionHandler) {
+        final Query queryCopy = query != null ? new Query(query) : new Query();
         return getClient().new AsyncTaskRequest(completionHandler) {
             @NonNull
             @Override JSONObject run() throws AlgoliaException {
@@ -126,7 +127,7 @@ public Request searchAsync(@NonNull Query query, @NonNull CompletionHandler comp
      *
      * @return Search results.
      */
-    public JSONObject searchSync(@NonNull Query query) throws AlgoliaException {
+    public JSONObject searchSync(@Nullable Query query) throws AlgoliaException {
         return search(query);
     }
 
@@ -836,7 +837,11 @@ protected void deleteByQuery(@NonNull Query query) throws AlgoliaException {
      * @return a JSONObject containing search results
      * @throws AlgoliaException
      */
-    protected JSONObject search(@NonNull Query query) throws AlgoliaException {
+    protected JSONObject search(@Nullable Query query) throws AlgoliaException {
+        if (query == null) {
+            query = new Query();
+        }
+
         String cacheKey = null;
         byte[] rawResponse = null;
         if (isCacheEnabled) {
@@ -862,7 +867,11 @@ protected JSONObject search(@NonNull Query query) throws AlgoliaException {
      * @return a byte array containing search results
      * @throws AlgoliaException
      */
-    protected byte[] searchRaw(@NonNull Query query) throws AlgoliaException {
+    protected byte[] searchRaw(@Nullable Query query) throws AlgoliaException {
+        if (query == null) {
+            query = new Query();
+        }
+
         try {
             String paramsString = query.build();
             if (paramsString.length() > 0) {

algoliasearch/src/main/java/com/algolia/search/saas/Query.java

@@ -1,6 +1,7 @@
 package com.algolia.search.saas;
 
 import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
 import android.text.TextUtils;
 
 import org.json.JSONArray;
@@ -1241,7 +1242,7 @@ private static String[] parseCommaArray(String string) {
      *              It will first be converted to a String by the `toString()` method.
      * @return This instance (used to chain calls).
      */
-    public @NonNull Query set(@NonNull String name, Object value) {
+    public @NonNull Query set(@NonNull String name, @Nullable Object value) {
         if (value == null) {
             parameters.remove(name);
         } else {
@@ -1255,7 +1256,7 @@ private static String[] parseCommaArray(String string) {
      * @param name The parameter's name.
      * @return The parameter's value, or null if a parameter with the specified name does not exist.
      */
-    public String get(@NonNull String name) {
+    public @Nullable String get(@NonNull String name) {
         return parameters.get(name);
     }
 }