fix: Checkstyle warnings

Author: tomdesair

src/main/java/me/desair/tus/server/HttpMethod.java

@@ -23,6 +23,7 @@ public enum HttpMethod {
   TRACE,
   PATCH;
 
+  /** Get the {@link HttpMethod} instance that matches the provided name. */
   public static HttpMethod forName(String name) {
     for (HttpMethod method : HttpMethod.values()) {
       if (StringUtils.equalsIgnoreCase(method.name(), name)) {
@@ -33,6 +34,10 @@ public static HttpMethod forName(String name) {
     return null;
   }
 
+  /**
+   * Get the {@link HttpMethod} instance of this request if it is present in the provided
+   * supportedHttpMethods set.
+   */
   public static HttpMethod getMethodIfSupported(
       HttpServletRequest request, Set<HttpMethod> supportedHttpMethods) {
     Validate.notNull(request, "The HttpServletRequest cannot be null");

src/main/java/me/desair/tus/server/TusExtension.java

@@ -8,18 +8,18 @@
 import me.desair.tus.server.util.TusServletRequest;
 import me.desair.tus.server.util.TusServletResponse;
 
-/** Interface that represents an extension in the tus protocol */
+/** Interface that represents an extension in the tus protocol. */
 public interface TusExtension {
 
   /**
-   * The name of the Tus extension that can be used to disable or enable the extension
+   * The name of the Tus extension that can be used to disable or enable the extension.
    *
    * @return The name of the extension
    */
   String getName();
 
   /**
-   * Validate the given request
+   * Validate the given request.
    *
    * @param method The HTTP method of this request (taking into account overrides)
    * @param servletRequest The HTTP request
@@ -36,7 +36,7 @@ void validate(
       throws TusException, IOException;
 
   /**
-   * Process the given request
+   * Process the given request.
    *
    * @param method The HTTP method of this request (taking into account overrides)
    * @param servletRequest The HTTP request
@@ -75,7 +75,7 @@ void handleError(
       throws IOException, TusException;
 
   /**
-   * The minimal list of HTTP methods that this extension needs to function properly
+   * The minimal list of HTTP methods that this extension needs to function properly.
    *
    * @return The list of HTTP methods required by this extension
    */

src/main/java/me/desair/tus/server/TusFileUploadService.java

@@ -49,6 +49,7 @@ public class TusFileUploadService {
   private boolean isThreadLocalCacheEnabled = false;
   private boolean isChunkedTransferDecodingEnabled = false;
 
+  /** Constructor. */
   public TusFileUploadService() {
     String storagePath = FileUtils.getTempDirectoryPath() + File.separator + "tus";
     this.uploadStorageService = new DiskStorageService(idFactory, storagePath);
@@ -104,9 +105,9 @@ public TusFileUploadService withMaxUploadSize(Long maxUploadSize) {
    */
   public TusFileUploadService withUploadIdFactory(UploadIdFactory uploadIdFactory) {
     Validate.notNull(uploadIdFactory, "The UploadIdFactory cannot be null");
-    String previousUploadURI = this.idFactory.getUploadUri();
+    String previousUploadUri = this.idFactory.getUploadUri();
     this.idFactory = uploadIdFactory;
-    this.idFactory.setUploadUri(previousUploadURI);
+    this.idFactory.setUploadUri(previousUploadUri);
     this.uploadStorageService.setIdFactory(this.idFactory);
     this.uploadLockingService.setIdFactory(this.idFactory);
     return this;

src/main/java/me/desair/tus/server/core/validation/TusResumableValidator.java

@@ -23,6 +23,7 @@
  */
 public class TusResumableValidator implements RequestValidator {
 
+  /** Validate tus protocol version. */
   public void validate(
       HttpMethod method,
       HttpServletRequest request,

src/main/java/me/desair/tus/server/download/DownloadGetRequestHandler.java

@@ -15,7 +15,7 @@
 import me.desair.tus.server.util.TusServletRequest;
 import me.desair.tus.server.util.TusServletResponse;
 
-/** Send the uploaded bytes of finished uploads */
+/** Send the uploaded bytes of finished uploads. */
 public class DownloadGetRequestHandler extends AbstractRequestHandler {
 
   private static final String CONTENT_DISPOSITION_FORMAT =

src/main/java/me/desair/tus/server/exception/UploadInProgressException.java

@@ -2,9 +2,10 @@
 
 /**
  * Exception thrown when accessing an upload that is still in progress and this is not supported by
- * the operation
+ * the operation.
  */
 public class UploadInProgressException extends TusException {
+  /** Constructor. */
   public UploadInProgressException(String message) {
     // 422 Unprocessable Entity
     // The request was well-formed but was unable to be followed due to semantic errors.

src/main/java/me/desair/tus/server/upload/UploadInfo.java

@@ -2,13 +2,13 @@
 
 import jakarta.servlet.http.HttpServletRequest;
 import java.io.Serializable;
+import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 import java.util.Date;
 import java.util.List;
 import java.util.Map;
 import java.util.TreeMap;
 import me.desair.tus.server.util.Utils;
-import org.apache.commons.codec.Charsets;
 import org.apache.commons.codec.binary.Base64;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.builder.EqualsBuilder;
@@ -36,7 +36,7 @@ public class UploadInfo implements Serializable {
   private List<String> concatenationPartIds;
   private String uploadConcatHeaderValue;
 
-  /** Default constructor to use if an upload is created without HTTP request */
+  /** Default constructor to use if an upload is created without HTTP request. */
   public UploadInfo() {
     creationTimestamp = getCurrentTime();
     offset = 0L;
@@ -45,7 +45,7 @@ public UploadInfo() {
   }
 
   /**
-   * Constructor to use if the upload is created using an HTTP request (which is usually the case)
+   * Constructor to use if the upload is created using an HTTP request (which is usually the case).
    *
    * @param servletRequest The HTTP request that creates the new upload
    */
@@ -131,7 +131,7 @@ public Map<String, String> getMetadata() {
   }
 
   /**
-   * Did the client provide any metadata when creating this upload?
+   * Check if the client provided any metadata when creating this upload.
    *
    * @return True if metadata is present, false otherwise
    */
@@ -160,7 +160,7 @@ public void setLength(Long length) {
   }
 
   /**
-   * Did the client already provide a total upload length?
+   * Check if the client already provided a total upload length.
    *
    * @return True if the total upload length is known, false otherwise
    */
@@ -170,7 +170,7 @@ public boolean hasLength() {
 
   /**
    * An upload is still in progress: - as long as we did not receive information on the total length
-   * (see {@link UploadInfo#getLength()}) - the total length does not match the current offset
+   * (see {@link UploadInfo#getLength()}) - the total length does not match the current offset.
    *
    * @return true if the upload is still in progress, false otherwise
    */
@@ -180,7 +180,7 @@ public boolean isUploadInProgress() {
 
   /**
    * Set the unique identifier of this upload process The unique identifier is represented by a
-   * {@link UploadId} instance
+   * {@link UploadId} instance.
    *
    * @param id The unique identifier to use
    */
@@ -190,7 +190,7 @@ public void setId(UploadId id) {
 
   /**
    * Get the unique identifier of this upload process The unique identifier is represented by a
-   * {@link UploadId} instance
+   * {@link UploadId} instance.
    *
    * @return The unique upload identifier of this upload
    */
@@ -222,7 +222,7 @@ public String getOwnerKey() {
 
   /**
    * Indicates the timestamp after which the upload expires in milliseconds since January 1, 1970,
-   * 00:00:00 GMT
+   * 00:00:00 GMT.
    *
    * @return The expiration timestamp in milliseconds
    */
@@ -241,7 +241,7 @@ public void updateExpiration(long expirationPeriod) {
 
   /**
    * The timestamp this upload was created in number of milliseconds since January 1, 1970, 00:00:00
-   * GMT
+   * GMT.
    *
    * @return Creation timestamp of this upload object
    */
@@ -301,7 +301,7 @@ public List<String> getConcatenationPartIds() {
   }
 
   /**
-   * Set the original value of the "Upload-Concat" HTTP header that was provided by the client
+   * Set the original value of the "Upload-Concat" HTTP header that was provided by the client.
    *
    * @param uploadConcatHeaderValue The original value of the "Upload-Concat" HTTP header
    */
@@ -310,7 +310,7 @@ public void setUploadConcatHeaderValue(String uploadConcatHeaderValue) {
   }
 
   /**
-   * Get the original value of the "Upload-Concat" HTTP header that was provided by the client
+   * Get the original value of the "Upload-Concat" HTTP header that was provided by the client.
    *
    * @return The original value of the "Upload-Concat" HTTP header
    */
@@ -354,7 +354,7 @@ public String getFileMimeType() {
   }
 
   /**
-   * Check if this upload is expired
+   * Check if this upload is expired.
    *
    * @return True if the upload is expired, false otherwise
    */
@@ -404,7 +404,7 @@ public int hashCode() {
         .toHashCode();
   }
 
-  /** Get the current time in the number of milliseconds since January 1, 1970, 00:00:00 GMT */
+  /** Get the current time in the number of milliseconds since January 1, 1970, 00:00:00 GMT. */
   protected long getCurrentTime() {
     return new Date().getTime();
   }
@@ -421,7 +421,7 @@ private String decode(String encodedValue) {
     if (encodedValue == null) {
       return null;
     } else {
-      return new String(Base64.decodeBase64(encodedValue), Charsets.UTF_8);
+      return new String(Base64.decodeBase64(encodedValue), StandardCharsets.UTF_8);
     }
   }
 }

src/main/java/me/desair/tus/server/upload/disk/FileBasedLock.java

@@ -31,6 +31,7 @@ public class FileBasedLock implements UploadLock {
   private FileChannel fileChannel = null;
   protected Path lockPath;
 
+  /** Constructor. */
   public FileBasedLock(String uploadUri, Path lockPath)
       throws UploadAlreadyLockedException, IOException {
     Validate.notBlank(uploadUri, "The upload URI cannot be blank");

src/main/java/me/desair/tus/server/util/AbstractRequestHandler.java

@@ -4,7 +4,7 @@
 
 /**
  * Abstract {@link me.desair.tus.server.RequestHandler} implementation that contains the common
- * functionality
+ * functionality.
  */
 public abstract class AbstractRequestHandler implements RequestHandler {
 

src/main/java/me/desair/tus/server/util/AbstractTusExtension.java

@@ -11,12 +11,13 @@
 import me.desair.tus.server.exception.TusException;
 import me.desair.tus.server.upload.UploadStorageService;
 
+/** Abstract class to implement a tus extension using validators and request handlers. */
 public abstract class AbstractTusExtension implements TusExtension {
 
   private List<RequestValidator> requestValidators = new LinkedList<>();
   private List<RequestHandler> requestHandlers = new LinkedList<>();
 
-  public AbstractTusExtension() {
+  protected AbstractTusExtension() {
     initValidators(requestValidators);
     initRequestHandlers(requestHandlers);
   }