code lint issue fixed

Clivern · Feb 27, 2018 · 2788aa2 · 2788aa2
1 parent cd1770e
commit 2788aa2
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 10 deletions.
diff --git a/src/main/java/com/clivern/wit/Wit.java b/src/main/java/com/clivern/wit/Wit.java
@@ -49,7 +49,11 @@ public Wit(Config config)
     /**
      * Send A Call To Wit.Ai
      *
+     * @param item Item Data to Send to Wit.AI
      * @return Boolean the call status
+     * @throws DataNotValid Data are not valid
+     * @throws DataNotFound Some data are missing
+     * @throws IOException Unable to send the request
      */
     public Boolean send(Contract item) throws DataNotValid, DataNotFound, IOException
     {

diff --git a/src/main/java/com/clivern/wit/api/Entity.java b/src/main/java/com/clivern/wit/api/Entity.java
@@ -247,7 +247,7 @@ public void setAccessToken(String accessToken)
     /**
      * Set the Entity ID
      *
-     * @param offset The Entity Id
+     * @param entityId The Entity Id
      */
     public void setEntityId(String entityId)
     {

diff --git a/src/main/java/com/clivern/wit/api/Message.java b/src/main/java/com/clivern/wit/api/Message.java
@@ -180,7 +180,7 @@ public Map<String, String> getHeaders()
     }
 
     /**
-     * Get Q (User’s query). Length must be > 0 and < 256
+     * Get Q (User’s query). Length must be more than 0 and less than 256
      *
      * @return String The users query
      */
@@ -270,7 +270,7 @@ public String getAccessToken()
     }
 
     /**
-     * Set Q (User’s query). Length must be > 0 and < 256
+     * Set Q (User’s query). Length must be more than 0 and less than 256
      *
      * @param q The users query
      */

diff --git a/src/main/java/com/clivern/wit/exception/DataNotFound.java b/src/main/java/com/clivern/wit/exception/DataNotFound.java
@@ -23,7 +23,7 @@ public class DataNotFound extends Exception {
     /**
      * Class Constructor
      *
-     * @param  exception
+     *  @param exception Exception Instance
      */
     public DataNotFound(Exception exception)
     {
@@ -33,7 +33,7 @@ public DataNotFound(Exception exception)
     /**
      * Class Constructor
      *
-     * @param  exception
+     * @param message Custom Message
      */
     public DataNotFound(String message)
     {

diff --git a/src/main/java/com/clivern/wit/exception/DataNotValid.java b/src/main/java/com/clivern/wit/exception/DataNotValid.java
@@ -23,7 +23,7 @@ public class DataNotValid extends Exception {
     /**
      * Class Constructor
      *
-     * @param  exception
+     * @param exception Exception Instance
      */
     public DataNotValid(Exception exception)
     {
@@ -33,7 +33,7 @@ public DataNotValid(Exception exception)
     /**
      * Class Constructor
      *
-     * @param  exception
+     * @param message Custom Message
      */
     public DataNotValid(String message)
     {

diff --git a/src/main/java/com/clivern/wit/util/Http.java b/src/main/java/com/clivern/wit/util/Http.java
@@ -16,8 +16,6 @@
 import java.util.HashMap;
 import java.util.Map;
 import org.pmw.tinylog.Logger;
-import java.net.URLEncoder;
-import java.io.UnsupportedEncodingException;
 import com.clivern.wit.exception.DataNotFound;
 import okhttp3.OkHttpClient;
 import okhttp3.MediaType;
@@ -75,8 +73,10 @@ public Http(String url, String method, Map<String, String> headers, String body)
      * Execute The API Call
      *
      * @return String The Response
+     * @throws DataNotFound some data missing
+     * @throws IOException Unable to do the call
      */
-    public String execute() throws DataNotFound, IOException, UnsupportedEncodingException
+    public String execute() throws DataNotFound, IOException
     {
         if( !this.headers.containsKey("Content-Type") || !this.headers.containsKey("Authorization") ){
             Logger.error("Error! Content-Type and Authorization required to make a request.");