fixed findings of review

apache · May 20, 2024 · 9945131 · 9945131
1 parent 96e3573
commit 9945131
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 2 deletions.
diff --git a/...pload2-core/src/main/java/org/apache/commons/fileupload2/core/AbstractRequestContext.java b/...pload2-core/src/main/java/org/apache/commons/fileupload2/core/AbstractRequestContext.java
@@ -24,7 +24,7 @@
 
 public abstract class AbstractRequestContext<T> implements RequestContext {
     /**
-     * the Content-Type Pattern for multipart/related Requests.
+     * The Content-Type Pattern for multipart/related Requests.
      */
     private static final Pattern MULTIPART_RELATED =
             Pattern.compile("^\\s*multipart/related.*", Pattern.CASE_INSENSITIVE);
@@ -85,6 +85,11 @@ public String toString() {
         return String.format("%s [ContentLength=%s, ContentType=%s]", getClass().getSimpleName(), getContentLength(), getContentType());
     }
 
+    /**
+     * Test the given <code>content-type</code> Value if it is of type <code>multipart/related</code>.
+     * @param contentType <code>content-type</code> to be tested
+     * @return does the given <code>content-type</code> Value start with <code>multipart/related</code>
+     */
     protected boolean isMultipartRelated(final String contentType) {
         return MULTIPART_RELATED.matcher(contentType).matches();
     }

diff --git a/...ad2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemInputIteratorImpl.java b/...ad2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemInputIteratorImpl.java
@@ -96,7 +96,7 @@ class FileItemInputIteratorImpl implements FileItemInputIterator {
     private boolean eof;
 
     /**
-     * is the Request of type <code>multipart/related</code>.
+     * Is the Request of type <code>multipart/related</code>.
      */
     private final boolean multipartRelated;
 

diff --git a/...ns-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/RequestContext.java b/...ns-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/RequestContext.java
@@ -74,6 +74,7 @@ default Charset getCharset() throws UnsupportedCharsetException {
      * Is the Request of type <code>multipart/related</code>?
      *
      * @return the Request is of type <code>multipart/related</code>
+     * @since 2.0.0
      */
     boolean isMultipartRelated();
 }
diff --git a/...in/java/org/apache/commons/fileupload2/jakarta/servlet5/JakartaServletRequestContext.java b/...in/java/org/apache/commons/fileupload2/jakarta/servlet5/JakartaServletRequestContext.java
@@ -72,6 +72,7 @@ public InputStream getInputStream() throws IOException {
      * Is the Request of type <code>multipart/related</code>?
      *
      * @return the Request is of type <code>multipart/related</code>
+     * @since 2.0.0
      */
     @Override
     public boolean isMultipartRelated() {

diff --git a/...in/java/org/apache/commons/fileupload2/jakarta/servlet6/JakartaServletRequestContext.java b/...in/java/org/apache/commons/fileupload2/jakarta/servlet6/JakartaServletRequestContext.java
@@ -72,6 +72,7 @@ public InputStream getInputStream() throws IOException {
      * Is the Request of type <code>multipart/related</code>?
      *
      * @return the Request is of type <code>multipart/related</code>
+     * @since 2.0.0
      */
     @Override
     public boolean isMultipartRelated() {

diff --git a/...-javax/src/main/java/org/apache/commons/fileupload2/javax/JavaxServletRequestContext.java b/...-javax/src/main/java/org/apache/commons/fileupload2/javax/JavaxServletRequestContext.java
@@ -72,6 +72,7 @@ public InputStream getInputStream() throws IOException {
      * Is the Request of type <code>multipart/related</code>?
      *
      * @return the Request is of type <code>multipart/related</code>
+     * @since 2.0.0
      */
     @Override
     public boolean isMultipartRelated() {

diff --git a/...tlet/src/main/java/org/apache/commons/fileupload2/portlet/JavaxPortletRequestContext.java b/...tlet/src/main/java/org/apache/commons/fileupload2/portlet/JavaxPortletRequestContext.java
@@ -72,6 +72,7 @@ public InputStream getInputStream() throws IOException {
      * Is the Request of type <code>multipart/related</code>?
      *
      * @return the Request is of type <code>multipart/related</code>
+     * @since 2.0.0
      */
     @Override
     public boolean isMultipartRelated() {