Lint and reformat codebase for Java 11 (#107)

* optimize imports

* version bump

* Automatic inspection and cleanup of code

* broad qol improvements

* optimized imports

* bulk reformat

* remove author blocks

Author: jspaetzel

gradle.properties

@@ -1,7 +1,7 @@
 group = com.hellosign
 archivesBaseName = hellosign-java-sdk
-version = 5.0.0
+version = 5.0.1
 description = HelloSign Java SDK
 
 sourceCompatibility = 11
-targetCompatibility = 11
+targetCompatibility = 11

src/main/java/com/hellosign/sdk/HelloSignClient.java

@@ -1,11 +1,9 @@
 package com.hellosign.sdk;
 
 /**
- * This class wraps all hellosign-java-sdk exceptions. This allows a developer
- * to determine where the exception is coming from. It also allows us to store
- * the HTTP code and error type from API calls.
- *
- * @author "Chris Paul (chris@hellosign.com)"
+ * This class wraps all hellosign-java-sdk exceptions. This allows a developer to determine where
+ * the exception is coming from. It also allows us to store the HTTP code and error type from API
+ * calls.
  */
 public class HelloSignException extends Exception {
 
@@ -41,8 +39,8 @@ public HelloSignException(String message, Integer httpCode, String type, Excepti
     }
 
     /**
-     * Returns the HTTP code associated with a HelloSign API call. This may be
-     * null if the exception does not involve an API request.
+     * Returns the HTTP code associated with a HelloSign API call. This may be null if the exception
+     * does not involve an API request.
      *
      * @return Integer or null if an HTTP code does not exist
      */
@@ -51,8 +49,8 @@ public Integer getHttpCode() {
     }
 
     /**
-     * Returns the HelloSign API error type. This may be null if the exception
-     * does not involve an API request.
+     * Returns the HelloSign API error type. This may be null if the exception does not involve an
+     * API request.
      *
      * @return String or null if the error type does not exist
      */

src/main/java/com/hellosign/sdk/HelloSignException.java

@@ -19,11 +19,9 @@
 
 public abstract class AbstractHttpRequest {
 
+    public static final String DEFAULT_ENCODING = "UTF-8";
+    public static final String USER_AGENT = createUserAgent();
     private static final Logger logger = LoggerFactory.getLogger(AbstractHttpRequest.class);
-
-    public final static String DEFAULT_ENCODING = "UTF-8";
-    public final static String USER_AGENT = createUserAgent();
-
     // Request variables
     protected String url;
     protected Authentication auth;
@@ -53,11 +51,44 @@ private static String createUserAgent() {
     }
 
     /**
-     * Executes this HTTP request and preserves the response stream and HTTP
-     * response code for processing.
+     * Creates an HTTP connection.
+     *
+     * Optionally checks for proxy parameters and creates a proxied connection using the system
+     * properties: "hellosign.proxy.url" - the URL of the HTTP proxy "hellosign.proxy.port" - the
+     * port of the HTTP proxy
+     *
+     * @param url String URL to connect to
+     * @return HttpUrlConnection the (proxied) connection to the URL
+     * @throws MalformedURLException thrown if the URL is invalid
+     * @throws IOException thrown if IO cannot be established with the URL
+     */
+    protected static HttpURLConnection getProxiedConnection(String url)
+        throws MalformedURLException, IOException {
+        HttpURLConnection conn;
+        Proxy proxy = null;
+        String proxyUrlStr = System.getProperty("hellosign.proxy.url");
+        String proxyPortStr = System.getProperty("hellosign.proxy.port");
+        int proxyPort = 80; // Default to port 80
+        if (proxyPortStr != null) {
+            proxyPort = Integer.parseInt(proxyPortStr);
+        }
+        if (proxyUrlStr != null) {
+            proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress(proxyUrlStr, proxyPort));
+        }
+        if (proxy == null) {
+            conn = (HttpURLConnection) new URL(url).openConnection();
+        } else {
+            conn = (HttpURLConnection) new URL(url).openConnection(proxy);
+        }
+        return conn;
+    }
+
+    /**
+     * Executes this HTTP request and preserves the response stream and HTTP response code for
+     * processing.
      *
-     * @throws HelloSignException Thrown if there is an error while making the
-     *         HTTP request to the HelloSign API.
+     * @throws HelloSignException Thrown if there is an error while making the HTTP request to the
+     * HelloSign API.
      */
     public void execute() throws HelloSignException {
         HttpURLConnection connection = getConnection();
@@ -106,57 +137,23 @@ public String getResponseBody() {
     }
 
     /**
-     * Creates an HTTP connection.
-     *
-     * Optionally checks for proxy parameters and creates a proxied connection
-     * using the system properties: "hellosign.proxy.url" - the URL of the HTTP
-     * proxy "hellosign.proxy.port" - the port of the HTTP proxy
-     *
-     * @param url String URL to connect to
-     * @return HttpUrlConnection the (proxied) connection to the URL
-     * @throws MalformedURLException thrown if the URL is invalid
-     * @throws IOException thrown if IO cannot be established with the URL
-     */
-    protected static HttpURLConnection getProxiedConnection(String url)
-        throws MalformedURLException, IOException {
-        HttpURLConnection conn = null;
-        Proxy proxy = null;
-        String proxyUrlStr = System.getProperty("hellosign.proxy.url");
-        String proxyPortStr = System.getProperty("hellosign.proxy.port");
-        Integer proxyPort = 80; // Default to port 80
-        if (proxyPortStr != null) {
-            proxyPort = Integer.parseInt(proxyPortStr);
-        }
-        if (proxyUrlStr != null) {
-            proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress(proxyUrlStr, proxyPort));
-        }
-        if (proxy == null) {
-            conn = (HttpURLConnection) new URL(url).openConnection();
-        } else {
-            conn = (HttpURLConnection) new URL(url).openConnection(proxy);
-        }
-        return conn;
-    }
-
-    /**
-     * The method class will create the appropriate connection with an endpoint,
-     * parameters, etc.
+     * The method class will create the appropriate connection with an endpoint, parameters, etc.
      *
      * @return HttpURLConnection
      * @throws HelloSignException Thrown if a connection cannot be created
      */
-    abstract protected HttpURLConnection getConnection() throws HelloSignException;
+    protected abstract HttpURLConnection getConnection() throws HelloSignException;
 
     /**
      * Write the last response to a file.
      *
      * @param f File
      * @return long bytes written
-     * @throws HelloSignException Thrown if an exception occurs during the copy
-     *         of the response stream to the given file.
+     * @throws HelloSignException Thrown if an exception occurs during the copy of the response
+     * stream to the given file.
      */
     public long getResponseAsFile(File f) throws HelloSignException {
-        long bytesWritten = 0;
+        long bytesWritten;
         try {
             bytesWritten = Files
                 .copy(lastResponseStream, f.toPath(), StandardCopyOption.REPLACE_EXISTING);

src/main/java/com/hellosign/sdk/http/AbstractHttpRequest.java

@@ -7,23 +7,18 @@
 import org.slf4j.LoggerFactory;
 
 /**
- * This class provides convenience methods for handling authentication
- * information for a HelloSignClient instance. We usually only want to use one
- * of these methods, but don't necessarily want to have to pass around all of
- * the information in method parameters.
- *
- * @author Chris Paul (chris@hellosign.com)
+ * This class provides convenience methods for handling authentication information for a
+ * HelloSignClient instance. We usually only want to use one of these methods, but don't necessarily
+ * want to have to pass around all of the information in method parameters.
  */
 public class Authentication {
 
     private static final Logger logger = LoggerFactory.getLogger(Authentication.class);
-
-    private String apiKey = new String();
-    private String accessToken = new String();
-    private String accessTokenType = new String();
-
     private static final String[] allowedOauthOps = {"account", "signature_request",
         "reusable_form", "template"};
+    private String apiKey = "";
+    private String accessToken = "";
+    private String accessTokenType = "";
 
     public Authentication() {
     }
@@ -47,7 +42,7 @@ public Authentication(Authentication clone) throws HelloSignException {
      * @return String API key
      */
     public String getApiKey() {
-        return new String(apiKey);
+        return apiKey;
     }
 
     /**
@@ -59,7 +54,7 @@ public void setApiKey(String apiKey) {
         if (apiKey == null) {
             return;
         }
-        this.apiKey = new String(apiKey);
+        this.apiKey = apiKey;
     }
 
     /**
@@ -77,7 +72,7 @@ public boolean hasApiKey() {
      * @return String access token
      */
     public String getAccessToken() {
-        return new String(accessToken);
+        return accessToken;
     }
 
     /**
@@ -86,16 +81,15 @@ public String getAccessToken() {
      * @return String access token type
      */
     public String getAccessTokenType() {
-        return new String(accessTokenType);
+        return accessTokenType;
     }
 
     /**
      * Sets the access token for the HelloSign client authentication.
      *
      * @param accessToken String
      * @param tokenType String
-     * @throws HelloSignException if either the accessToken or tokenType are
-     *         null
+     * @throws HelloSignException if either the accessToken or tokenType are null
      */
     public void setAccessToken(String accessToken, String tokenType) throws HelloSignException {
         if (accessToken == null) {
@@ -104,8 +98,8 @@ public void setAccessToken(String accessToken, String tokenType) throws HelloSig
         if (tokenType == null) {
             throw new HelloSignException("Token Type cannot be null");
         }
-        this.accessToken = new String(accessToken);
-        this.accessTokenType = new String(tokenType);
+        this.accessToken = accessToken;
+        this.accessTokenType = tokenType;
     }
 
     /**

src/main/java/com/hellosign/sdk/http/Authentication.java

@@ -11,7 +11,6 @@
 import javax.net.ssl.HostnameVerifier;
 import javax.net.ssl.HttpsURLConnection;
 import javax.net.ssl.SSLContext;
-import javax.net.ssl.SSLSession;
 import javax.net.ssl.TrustManager;
 import javax.net.ssl.X509TrustManager;
 import org.json.JSONException;
@@ -35,7 +34,7 @@ public class HttpClient {
 
     public HttpClient() {
         String disableSslCheck = System.getProperty("hellosign.disable.ssl");
-        if (disableSslCheck != null && "true".equalsIgnoreCase(disableSslCheck)) {
+        if ("true".equalsIgnoreCase(disableSslCheck)) {
             disableStrictSSL();
         }
     }
@@ -47,7 +46,7 @@ public HttpClient withAuth(Authentication auth) {
 
     public HttpClient withGetParam(String key, String value) {
         if (getParams == null) {
-            getParams = new HashMap<String, String>();
+            getParams = new HashMap<>();
         }
         getParams.put(key, value);
         return this;
@@ -60,7 +59,7 @@ public HttpClient withGetParams(Map<String, String> params) {
 
     public HttpClient withPostField(String key, Serializable value) {
         if (postFields == null) {
-            postFields = new HashMap<String, Serializable>();
+            postFields = new HashMap<>();
         }
         postFields.put(key, value);
         return this;
@@ -100,21 +99,18 @@ public Integer getLastResponseCode() {
      *
      * @param f File that should contain the response
      * @return long bytes written
-     * @throws HelloSignException thrown if there is a problem writing to the
-     *         file or reading the response stream
+     * @throws HelloSignException thrown if there is a problem writing to the file or reading the
+     * response stream
      */
     public long getLastResponseAsFile(File f) throws HelloSignException {
         return request.getResponseAsFile(f);
     }
 
     /**
-     * Inspects the JSONObject response for errors and throws an exception if
-     * found.
+     * Inspects the JSONObject response for errors and throws an exception if found.
      *
      * @param json JSONObject response
-     * @param code HTTP response code
-     * @throws HelloSignException thrown if an error is reported from the API
-     *         call
+     * @throws HelloSignException thrown if an error is reported from the API call
      */
     private void validate(JSONObject json) throws HelloSignException {
         if (json.has("error")) {
@@ -143,11 +139,10 @@ private void reset() {
      * Executes the request and returns the response as a JSONObject.
      *
      * @return JSONObject response
-     * @throws HelloSignException thrown if there is a problem executing the
-     *         request
+     * @throws HelloSignException thrown if there is a problem executing the request
      */
     public JSONObject asJson() throws HelloSignException {
-        JSONObject json = null;
+        JSONObject json;
         String response = getLastResponse();
         logger.debug("Response body: " + response);
         try {
@@ -168,12 +163,11 @@ public JSONObject asJson() throws HelloSignException {
      *
      * @param fileName String name of destination file
      * @return File response
-     * @throws HelloSignException thrown if there is a problem executing the
-     *         request
+     * @throws HelloSignException thrown if there is a problem executing the request
      */
     public File asFile(String fileName) throws HelloSignException {
         Integer lastResponseCode = getLastResponseCode();
-        File f = null;
+        File f;
         try {
             if (lastResponseCode != null && lastResponseCode != HttpURLConnection.HTTP_OK) {
                 this.asJson(); // Will validate response
@@ -199,11 +193,11 @@ public File asFile(String fileName) throws HelloSignException {
      */
     private File createTemporaryFile(String filename) throws HelloSignException {
         String prefix = filename.substring(0, filename.indexOf("."));
-        String postfix = filename.substring(filename.indexOf(".") + 1, filename.length());
-        if (prefix == null || postfix == null) {
+        String postfix = filename.substring(filename.indexOf(".") + 1);
+        if (prefix.isBlank() || postfix.isBlank()) {
             throw new HelloSignException("Invalid file name: " + prefix + "." + postfix);
         }
-        File f = null;
+        File f;
         try {
             f = File.createTempFile(prefix, "." + postfix);
         } catch (Exception ex) {
@@ -302,8 +296,7 @@ public HttpClient options(String url) throws HelloSignException {
     }
 
     /**
-     * Helper method that allows this client to ignore SSL certificates when
-     * making API requests.
+     * Helper method that allows this client to ignore SSL certificates when making API requests.
      */
     private void disableStrictSSL() {
         // Create a trust manager that does not validate certificate chains
@@ -320,11 +313,7 @@ public void checkServerTrusted(X509Certificate[] certs, String authType) {
         }};
 
         // Ignore differences between given hostname and certificate hostname
-        HostnameVerifier hv = new HostnameVerifier() {
-            public boolean verify(String hostname, SSLSession session) {
-                return true;
-            }
-        };
+        HostnameVerifier hv = (hostname, session) -> true;
 
         // Install the all-trusting trust manager
         try {