Linted codebase (#44)

cdr-chakotay · web-flow · commit 5c2a70ee9d65 · 2021-08-23T15:15:29.000+02:00
* Linted the Code of the TUS-Java-SDK to prepare for the Linter in the CI Workflow

* Requested changes
diff --git a/example/src/main/java/io/tus/java/example/Main.java b/example/src/main/java/io/tus/java/example/Main.java
@@ -11,7 +11,14 @@
 import io.tus.java.client.TusUpload;
 import io.tus.java.client.TusUploader;
 
-public class Main {
+/**
+ * A representative Example class to show an usual usecase.
+ */
+public final class Main {
+    /**
+     * Main method to run a standard upload task.
+     * @param args
+     */
     public static void main(String[] args) {
         try {
             // When Java's HTTP client follows a redirect for a POST request, it will change the
@@ -71,7 +78,7 @@ protected void makeAttempt() throws ProtocolException, IOException {
                         double progress = (double) bytesUploaded / totalBytes * 100;
 
                         System.out.printf("Upload at %06.2f%%.\n", progress);
-                    } while(uploader.uploadChunk() > -1);
+                    } while (uploader.uploadChunk() > -1);
 
                     // Allow the HTTP connection to be closed and cleaned up
                     uploader.finish();
@@ -81,9 +88,12 @@ protected void makeAttempt() throws ProtocolException, IOException {
                 }
             };
             executor.makeAttempts();
-        } catch(Exception e) {
+        } catch (Exception e) {
             e.printStackTrace();
         }
 
     }
+    private Main() {
+        throw new IllegalStateException("Utility class");
+    }
 }
diff --git a/example/src/main/java/io/tus/java/example/package-info.java b/example/src/main/java/io/tus/java/example/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * This package contains example classes for TUS-Client usage.
+ */
+package io.tus.java.example;
diff --git a/src/main/java/io/tus/java/client/FingerprintNotFoundException.java b/src/main/java/io/tus/java/client/FingerprintNotFoundException.java
@@ -5,6 +5,10 @@
  * has been stored in the {@link TusURLStore}.
  */
 public class FingerprintNotFoundException  extends Exception {
+    /**
+     * Instantiates a new Object of type {@link FingerprintNotFoundException}.
+     * @param fingerprint
+     */
     public FingerprintNotFoundException(String fingerprint) {
         super("fingerprint not in storage found: " + fingerprint);
     }
diff --git a/src/main/java/io/tus/java/client/ProtocolException.java b/src/main/java/io/tus/java/client/ProtocolException.java
@@ -10,21 +10,38 @@
 public class ProtocolException extends Exception {
     private HttpURLConnection connection;
 
+    /**
+     * Instantiates a new Object of type {@link ProtocolException}.
+     * @param message Message to be thrown with the exception.
+     */
     public ProtocolException(String message) {
         super(message);
     }
 
+    /**
+     Instantiates a new Object of type {@link ProtocolException}.
+     * @param message Message to be thrown with the exception.
+     * @param connection {@link HttpURLConnection}, where the error occurred.
+     */
     public ProtocolException(String message, HttpURLConnection connection) {
         super(message);
         this.connection = connection;
     }
 
+    /**
+     * Returns the {@link HttpURLConnection} instances, which caused the error.
+     * @return {@link HttpURLConnection}
+     */
     public HttpURLConnection getCausingConnection() {
         return connection;
     }
 
+    /**
+     * Determines whether a retry attempt should be made after a {@link ProtocolException} or not.
+     * @return {@code true} if there should be a retry attempt.
+     */
     public boolean shouldRetry() {
-        if(connection == null) {
+        if (connection == null) {
             return false;
         }
 
@@ -33,7 +50,7 @@ public boolean shouldRetry() {
 
             // 5XX and 423 Resource Locked status codes should be retried.
             return (responseCode >= 500 && responseCode < 600) || responseCode == 423;
-        } catch(IOException e) {
+        } catch (IOException e) {
             return false;
         }
     }
diff --git a/src/main/java/io/tus/java/client/ResumingNotEnabledException.java b/src/main/java/io/tus/java/client/ResumingNotEnabledException.java
@@ -5,6 +5,9 @@
  * {@link TusClient#resumeUpload(TusUpload)} without enabling it first.
  */
 public class ResumingNotEnabledException extends Exception {
+    /**
+     * Instantiates a new Object of Type {@link ResumingNotEnabledException}.
+     */
     public ResumingNotEnabledException() {
         super("resuming not enabled for this client. use enableResuming() to do so");
     }
diff --git a/src/main/java/io/tus/java/client/TusClient.java b/src/main/java/io/tus/java/client/TusClient.java
@@ -16,7 +16,7 @@ public class TusClient {
      * Version of the tus protocol used by the client. The remote server needs to support this
      * version, too.
      */
-    public final static String TUS_VERSION = "1.0.0";
+    public static final String TUS_VERSION = "1.0.0";
 
     private URL uploadCreationURL;
     private boolean resumingEnabled;
@@ -44,7 +44,7 @@ public void setUploadCreationURL(URL uploadCreationURL) {
     }
 
     /**
-     * Get the current upload creation URL
+     * Get the current upload creation URL.
      *
      * @return Current upload creation URL
      */
@@ -144,10 +144,18 @@ public Map<String, String> getHeaders() {
         return headers;
     }
 
+    /**
+     * Sets the timeout for a Connection.
+     * @param timeout in milliseconds
+     */
     public void setConnectTimeout(int timeout) {
         connectTimeout = timeout;
     }
 
+    /**
+     * Returns the Connection Timeout.
+     * @return Timeout in milliseconds.
+     */
     public int getConnectTimeout() {
         return connectTimeout;
     }
@@ -171,20 +179,21 @@ public TusUploader createUpload(@NotNull TusUpload upload) throws ProtocolExcept
         prepareConnection(connection);
 
         String encodedMetadata = upload.getEncodedMetadata();
-        if(encodedMetadata.length() > 0) {
+        if (encodedMetadata.length() > 0) {
             connection.setRequestProperty("Upload-Metadata", encodedMetadata);
         }
 
         connection.addRequestProperty("Upload-Length", Long.toString(upload.getSize()));
         connection.connect();
 
         int responseCode = connection.getResponseCode();
-        if(!(responseCode >= 200 && responseCode < 300)) {
-            throw new ProtocolException("unexpected status code (" + responseCode + ") while creating upload", connection);
+        if (!(responseCode >= 200 && responseCode < 300)) {
+            throw new ProtocolException(
+                    "unexpected status code (" + responseCode + ") while creating upload", connection);
         }
 
         String urlStr = connection.getHeaderField("Location");
-        if(urlStr == null || urlStr.length() == 0) {
+        if (urlStr == null || urlStr.length() == 0) {
             throw new ProtocolException("missing upload URL in response for creating upload", connection);
         }
 
@@ -193,7 +202,7 @@ public TusUploader createUpload(@NotNull TusUpload upload) throws ProtocolExcept
         // but there may be cases in which the POST request is redirected.
         URL uploadURL = new URL(connection.getURL(), urlStr);
 
-        if(resumingEnabled) {
+        if (resumingEnabled) {
             urlStore.set(upload.getFingerprint(), uploadURL);
         }
 
@@ -217,7 +226,8 @@ public TusUploader createUpload(@NotNull TusUpload upload) throws ProtocolExcept
      * wrong status codes or missing/invalid headers.
      * @throws IOException Thrown if an exception occurs while issuing the HTTP request.
      */
-    public TusUploader resumeUpload(@NotNull TusUpload upload) throws FingerprintNotFoundException, ResumingNotEnabledException, ProtocolException, IOException {
+    public TusUploader resumeUpload(@NotNull TusUpload upload) throws
+            FingerprintNotFoundException, ResumingNotEnabledException, ProtocolException, IOException {
         if (!resumingEnabled) {
             throw new ResumingNotEnabledException();
         }
@@ -247,20 +257,22 @@ public TusUploader resumeUpload(@NotNull TusUpload upload) throws FingerprintNot
      * wrong status codes or missing/invalid headers.
      * @throws IOException Thrown if an exception occurs while issuing the HTTP request.
      */
-    public TusUploader beginOrResumeUploadFromURL(@NotNull TusUpload upload, @NotNull URL uploadURL) throws ProtocolException, IOException {
+    public TusUploader beginOrResumeUploadFromURL(@NotNull TusUpload upload, @NotNull URL uploadURL) throws
+            ProtocolException, IOException {
         HttpURLConnection connection = (HttpURLConnection) uploadURL.openConnection();
         connection.setRequestMethod("HEAD");
         prepareConnection(connection);
 
         connection.connect();
 
         int responseCode = connection.getResponseCode();
-        if(!(responseCode >= 200 && responseCode < 300)) {
-            throw new ProtocolException("unexpected status code (" + responseCode + ") while resuming upload", connection);
+        if (!(responseCode >= 200 && responseCode < 300)) {
+            throw new ProtocolException(
+                    "unexpected status code (" + responseCode + ") while resuming upload", connection);
         }
 
         String offsetStr = connection.getHeaderField("Upload-Offset");
-        if(offsetStr == null || offsetStr.length() == 0) {
+        if (offsetStr == null || offsetStr.length() == 0) {
             throw new ProtocolException("missing upload offset in response for resuming upload", connection);
         }
         long offset = Long.parseLong(offsetStr);
@@ -277,19 +289,20 @@ public TusUploader beginOrResumeUploadFromURL(@NotNull TusUpload upload, @NotNul
      * @throws ProtocolException Thrown if the remote server sent an unexpected response, e.g.
      * wrong status codes or missing/invalid headers.
      * @throws IOException Thrown if an exception occurs while issuing the HTTP request.
+     * @return {@link TusUploader} instance.
      */
     public TusUploader resumeOrCreateUpload(@NotNull TusUpload upload) throws ProtocolException, IOException {
         try {
             return resumeUpload(upload);
-        } catch(FingerprintNotFoundException e) {
+        } catch (FingerprintNotFoundException e) {
             return createUpload(upload);
-        } catch(ResumingNotEnabledException e) {
+        } catch (ResumingNotEnabledException e) {
             return createUpload(upload);
-        } catch(ProtocolException e) {
+        } catch (ProtocolException e) {
             // If the attempt to resume returned a 404 Not Found, we immediately try to create a new
             // one since TusExectuor would not retry this operation.
             HttpURLConnection connection = e.getCausingConnection();
-            if(connection != null && connection.getResponseCode() == 404) {
+            if (connection != null && connection.getResponseCode() == 404) {
                 return createUpload(upload);
             }
 
@@ -306,13 +319,16 @@ public TusUploader resumeOrCreateUpload(@NotNull TusUpload upload) throws Protoc
     public void prepareConnection(@NotNull HttpURLConnection connection) {
         // Only follow redirects, if the POST methods is preserved. If http.strictPostRedirect is
         // disabled, a POST request will be transformed into a GET request which is not wanted by us.
-        // See: http://grepcode.com/file/repository.grepcode.com/java/root/jdk/openjdk/7u40-b43/sun/net/www/protocol/http/HttpURLConnection.java#2372
+        // CHECKSTYLE:OFF
+        // Necessary because of length of the link
+        // See:https://github.com/openjdk/jdk/blob/jdk7-b43/jdk/src/share/classes/sun/net/www/protocol/http/HttpURLConnection.java#L2020-L2035
+        // CHECKSTYLE:ON
         connection.setInstanceFollowRedirects(Boolean.getBoolean("http.strictPostRedirect"));
 
         connection.setConnectTimeout(connectTimeout);
         connection.addRequestProperty("Tus-Resumable", TUS_VERSION);
 
-        if(headers != null) {
+        if (headers != null) {
             for (Map.Entry<String, String> entry : headers.entrySet()) {
                 connection.addRequestProperty(entry.getKey(), entry.getValue());
             }
diff --git a/src/main/java/io/tus/java/client/TusExecutor.java b/src/main/java/io/tus/java/client/TusExecutor.java
@@ -78,27 +78,27 @@ public int[] getDelays() {
      */
     public boolean makeAttempts() throws ProtocolException, IOException {
         int attempt = -1;
-        while(true) {
+        while (true) {
             attempt++;
 
             try {
                 makeAttempt();
                 // Returning true is the signal that the makeAttempt() function exited without
                 // throwing an error.
                 return true;
-            } catch(ProtocolException e) {
+            } catch (ProtocolException e) {
                 // Do not attempt a retry, if the Exception suggests so.
-                if(!e.shouldRetry()) {
+                if (!e.shouldRetry()) {
                     throw e;
                 }
 
-                if(attempt >= delays.length) {
+                if (attempt >= delays.length) {
                     // We exceeds the number of maximum retries. In this case the latest exception
                     // is thrown.
                     throw e;
                 }
-            }  catch(IOException e) {
-                if(attempt >= delays.length) {
+            }  catch (IOException e) {
+                if (attempt >= delays.length) {
                     // We exceeds the number of maximum retries. In this case the latest exception
                     // is thrown.
                     throw e;
@@ -108,7 +108,7 @@ public boolean makeAttempts() throws ProtocolException, IOException {
             try {
                 // Sleep for the specified delay before attempting the next retry.
                 Thread.sleep(delays[attempt]);
-            } catch(InterruptedException e) {
+            } catch (InterruptedException e) {
                 // If we get interrupted while waiting for the next retry, the user has cancelled
                 // the upload willingly and we return false as a signal.
                 return false;
diff --git a/src/main/java/io/tus/java/client/TusInputStream.java b/src/main/java/io/tus/java/client/TusInputStream.java
@@ -19,8 +19,8 @@ class TusInputStream {
      *
      * @param stream The stream to read from
      */
-    public TusInputStream(InputStream stream) {
-        if(!stream.markSupported()) {
+    TusInputStream(InputStream stream) {
+        if (!stream.markSupported()) {
             stream = new BufferedInputStream(stream);
         }
 
@@ -50,7 +50,7 @@ public int read(byte[] buffer, int length) throws IOException {
      * @throws IOException
      */
     public void seekTo(long position) throws IOException {
-        if(lastMark != -1) {
+        if (lastMark != -1) {
             stream.reset();
             stream.skip(position - lastMark);
             lastMark = -1;
diff --git a/src/main/java/io/tus/java/client/TusURLMemoryStore.java b/src/main/java/io/tus/java/client/TusURLMemoryStore.java
@@ -13,21 +13,34 @@
  * keep the values after your application crashes or restarts.
  */
 public class TusURLMemoryStore implements TusURLStore {
+    private Map<String, URL> store = new HashMap<String, URL>();
 
-	private Map<String, URL> store = new HashMap<String, URL>();
+    /**
+     * Stores the upload's fingerprint and url.
+     * @param fingerprint An upload's fingerprint.
+     * @param url The corresponding upload URL.
+     */
+    @Override
+    public void set(String fingerprint, URL url) {
+        store.put(fingerprint, url);
+    }
 
-	@Override
-	public void set(String fingerprint, URL url) {
-		store.put(fingerprint, url);
-	}
+    /**
+     * Returns the corresponding Upload URL to a given fingerprint.
+     * @param fingerprint An upload's fingerprint.
+     * @return The corresponding upload URL.
+     */
+    @Override
+    public URL get(String fingerprint) {
+        return store.get(fingerprint);
+    }
 
-	@Override
-	public URL get(String fingerprint) {
-		return store.get(fingerprint);
-	}
-
-	@Override
-	public void remove(String fingerprint) {
-		store.remove(fingerprint);
-	}
+    /**
+     * Removes the corresponding entry to a fingerprint from the {@link TusURLMemoryStore}.
+     * @param fingerprint An upload's fingerprint.
+     */
+    @Override
+    public void remove(String fingerprint) {
+        store.remove(fingerprint);
+    }
 }
diff --git a/src/main/java/io/tus/java/client/TusUpload.java b/src/main/java/io/tus/java/client/TusUpload.java
diff --git a/src/main/java/io/tus/java/client/TusUploader.java b/src/main/java/io/tus/java/client/TusUploader.java
diff --git a/src/main/java/io/tus/java/client/package-info.java b/src/main/java/io/tus/java/client/package-info.java

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +/**
 + * This package contains example classes for TUS-Client usage.
 + */
 +package io.tus.java.example;