Merge pull request #29 from contentstack/querying_with_null

Querying with null

Author: ishaileshmishra

CHANGELOG.md

@@ -1,5 +1,11 @@
+# CHANGELOG
 
-## CHANGELOG
+## Version 1.5.7
+###### Date: 20-Feb-2021
+Document updated
+
+#23 Fixed Issue: Querying content with `null` field
+• Query: query content by specifying fields as null
 
 ## Version 1.5.6
 ###### Date: 27-Jan-2021

README.md

@@ -20,13 +20,13 @@ To use the Contentstack Java SDK to your existing project, perform the steps giv
 <dependency>
   <groupId>com.contentstack.sdk</groupId>
   <artifactId>java</artifactId>
-  <version>1.5.6</version>
+  <version>1.5.7</version>
 </dependency>
 ```
 
 2. **Gradle**
 ```java
-implementation 'com.contentstack.sdk:java:1.5.6'
+implementation 'com.contentstack.sdk:java:1.5.7'
 ```
 
 ### Key Concepts for using Contentstack
@@ -59,7 +59,7 @@ A publishing environment corresponds to one or more deployment servers or a cont
 
 To initialize the SDK, specify application  API key, access token, and environment name of the stack as shown in the snippet given below:
 ```java
-Stack stack = Contentstack.stack( "apiKey", "accessToken", "environment_name");
+Stack stack = Contentstack.stack( "APIKey", "accessToken", "environment_name");
 ```
 To get the API credentials mentioned above, log in to your Contentstack account and then in your top panel navigation, go to Settings &gt; Stack to view the API Key and Access Token.
 
@@ -73,13 +73,13 @@ To retrieve a single entry from a content type use the code snippet given below:
 ContentType contentType = stack.contentType("content_type_uid");
 Entry blogEntry = contentType.entry("entry_uid");
 blogEntry.fetch(new EntryResultCallBack() {
-@Override
-public void onCompletion(ResponseType responseType, Error error) {
-    if (error == null) {
-         [Success block]
-    } else {
-         [Error block]
-    }}
+    @Override
+    public void onCompletion(ResponseType responseType, Error error) {
+        if (error == null) {
+           //Success block
+        } else {
+           //Error block
+        }}
  });
   ```
 ##### Get Multiple Entries
@@ -90,13 +90,14 @@ To retrieve multiple entries of a particular content type, use the code snippet
 //stack is an instance of Stack class
 Query blogQuery = stack.contentType("content_type_uid").query();
 blogQuery.find(new QueryResultsCallBack() {
-@Override
-publicvoidonCompletion(ResponseType responseType, QueryResult queryResult, Error error) {
-    if(error == null){
-       [Success block]
-    }else{
-       [Error block]
-    }}});
+    @Override
+    public void onCompletion(ResponseType responseType, QueryResult queryResult, Error error) {
+        if(error == null){
+           //Success block
+        }else{
+           //Error block
+    }}
+});
   ```
 
 

pom.xml

@@ -6,7 +6,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.contentstack.sdk</groupId>
     <artifactId>java</artifactId>
-    <version>1.5.6</version>
+    <version>1.5.7</version>
     <packaging>jar</packaging>
     <name>contentstack-java</name>
     <description>Java SDK for Contentstack Content Delivery API, Contentstack is a headless CMS with an API-first approach

src/main/java/com/contentstack/sdk/CSHttpConnection.java

@@ -222,22 +222,22 @@ public void send() {
 
     private void sendGET(String GET_URL) throws IOException, JSONException {
         URL obj = new URL(GET_URL);
-        HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-        con.setRequestMethod("GET");
+        HttpURLConnection conn = (HttpURLConnection) obj.openConnection();
+        conn.setRequestMethod("GET");
         if (this.headers.containsKey("api_key")){
-            con.setRequestProperty("api_key", headers.get("api_key").toString());
+            conn.setRequestProperty("api_key", headers.get("api_key").toString());
         }
         if (this.headers.containsKey("access_token")){
-            con.setRequestProperty("access_token", headers.get("access_token").toString());
+            conn.setRequestProperty("access_token", headers.get("access_token").toString());
         }
         if (this.headers.containsKey("environment")){
-            con.setRequestProperty("environment", headers.get("environment").toString());
+            conn.setRequestProperty("environment", headers.get("environment").toString());
         }
-        con.setRequestProperty("X-User-Agent", defaultUserAgent()+"/"+ CSAppConstants.SDK_VERSION);
-        con.setRequestProperty("Content-Type", "application/json");
-        int responseCode = con.getResponseCode();
+        conn.setRequestProperty("X-User-Agent", defaultUserAgent()+"/"+ CSAppConstants.SDK_VERSION);
+        conn.setRequestProperty("Content-Type", "application/json");
+        int responseCode = conn.getResponseCode();
         if (responseCode == HttpURLConnection.HTTP_OK) { // success
-            BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream(), StandardCharsets.UTF_8));
+            BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream(), StandardCharsets.UTF_8));
             String inputLine;
             StringBuilder response = new StringBuilder();
             while ((inputLine = in.readLine()) != null) {
@@ -248,7 +248,7 @@ private void sendGET(String GET_URL) throws IOException, JSONException {
             connectionRequest.onRequestFinished(CSHttpConnection.this);
         } else {
             // Setting up error details, like error_message, error_code, error_details
-            settingErrorInfo(con);
+            settingErrorInfo(conn);
         }
 
     }

src/main/java/com/contentstack/sdk/Query.java

@@ -19,7 +19,7 @@ public class Query implements INotifyClass {
     protected LinkedHashMap<String, Object> formHeader = null;
     private JSONObject mainJSON = null;
     private String formName = null;
-    private JSONObject urlQueries = null;
+    protected JSONObject urlQueries = null;
     private LinkedHashMap<String, Object> localHeader = null;
     private QueryResultsCallBack queryResultCallback;
     private SingleQueryResultCallback singleQueryResultCallback;
@@ -1521,7 +1521,6 @@ private LinkedHashMap<String, Object> getUrlParams(JSONObject jsonMain) {
                     e.printStackTrace();
                 }
             }
-
             return hashMap;
         }
 
@@ -1611,26 +1610,28 @@ private LinkedHashMap<String, Object> getHeader(LinkedHashMap<String, Object> lo
 
     /**
      * This method adds key and value to an Entry.
+     * Parameters:
+     *
+     * @param key: The key as string which needs to be added to the Query
+     * @param value: The value as string which needs to be added to the Query
+     * @return - Query
      *
-     * @param key   The key as string which needs to be added to the Query
-     * @param value The value as string which needs to be added to the Query
-     * @return {@link Query}
      * <br><br><b>Example :</b><br>
      * <pre class="prettyprint">
      *      Stack stack = Contentstack.stack( "APIKey", "deliveryToken", "environment_name");
-     *      Query csQuery = stack.contentType("contentType_name").query();<br>
+     *      Query csQuery = stack.contentType("contentType_name").query();
      *      csQuery.addParam("key", "some_value");
-     *      csQuery.findOne(new QueryResultsCallBack() {<br>
+     *      csQuery.findOne(new QueryResultsCallBack() {
      *          &#64;Override
-     *          public void onCompletion(ResponseType responseType, ENTRY entry, Error error) {<br>
+     *          public void onCompletion(ResponseType responseType, ENTRY entry, Error error) {
      *          }
-     *      });<br>
+     *      });
      * </pre>
      */
     public Query addParam(String key, String value) {
         try {
-            if (key != null && value != null) {
-                urlQueries.put(key, value);
+            if (key != null) {
+                urlQueries.put(key, value == null ? JSONObject.NULL : value);
             } else {
                 throwException("and", CSAppConstants.ErrorMessage_QueryFilterException, null);
             }

src/main/java/com/contentstack/sdk/Stack.java

@@ -111,7 +111,7 @@ protected Asset asset(){
 
     /**
      * assetLibrary returns AssetLibrary instance
-     * @return @{@link AssetLibrary}
+     * @return AssetLibrary
      */
     public AssetLibrary assetLibrary(){
         AssetLibrary library = new AssetLibrary();
@@ -122,21 +122,21 @@ public AssetLibrary assetLibrary(){
 
     /**
      * Returns apiKey of particular stack
-     * @return @{@link String} stack api key
+     * @return stack api key
      */
     public String getApplicationKey(){ return stackApiKey;}
 
 
     /**
      * Returns accessToken of particular stack
-     * @return @{@link String} access token of particular stack
+     * @return  access token of particular stack
      */
     public String getAccessToken(){ return localHeader != null ? (String)localHeader.get("access_token") : null;};
 
 
     /**
      * Removes Header by key
-     * @param key @{@link String} header key
+     * @param key header key
      * <br><br><b>Example :</b><br>
      *  stack.removeHeader("delivery_token");
      * <br><br>
@@ -151,11 +151,11 @@ public void removeHeader(String key){
 
     /**
      * Adds header to the stack by key and value
-     * @param key @{@link String} header key
-     * @param value @{@link String} header value
+     * @param key header key
+     * @param value header value
      *  <p>
-     *              Example
-     *              stack.setHeader("delivery_token","blt843748744");
+     *       Example
+     *       stack.setHeader("delivery_token","blt843748744");
      *  </p>
      */
     public void setHeader(String key, String value) {

src/main/java/com/contentstack/sdk/utility/CSAppConstants.java

@@ -6,7 +6,7 @@
 
 public class CSAppConstants {
 
-    public static final String SDK_VERSION = "1.5.6";
+    public static final String SDK_VERSION = "1.5.7";
 
     public static enum RequestMethod
     {