This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 1.x
in repository https://gitbox.apache.org/repos/asf/commons-fileupload.git
commit 80c1df2ec73b235c3590c4aaabd6b3bccef72076
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Sep 15 22:59:54 2023 +0100
Better Javadoc / comments
---
src/main/java/org/apache/commons/fileupload/FileItem.java | 2 +-
src/main/java/org/apache/commons/fileupload/FileUpload.java | 2 +-
.../java/org/apache/commons/fileupload/MultipartStream.java | 2 +-
.../java/org/apache/commons/fileupload/ParameterParser.java | 2 +-
.../org/apache/commons/fileupload/disk/DiskFileItem.java | 2 +-
.../apache/commons/fileupload/disk/DiskFileItemFactory.java | 2 +-
.../apache/commons/fileupload/portlet/PortletFileUpload.java | 2 +-
.../apache/commons/fileupload/servlet/ServletFileUpload.java | 2 +-
.../apache/commons/fileupload/util/FileItemHeadersImpl.java | 9 ---------
.../org/apache/commons/fileupload/util/mime/MimeUtility.java | 4 ++--
.../commons/fileupload/util/mime/QuotedPrintableDecoder.java | 2 +-
.../apache/commons/fileupload/util/mime/RFC2231Utility.java | 12 +++++-------
12 files changed, 16 insertions(+), 27 deletions(-)
diff --git a/src/main/java/org/apache/commons/fileupload/FileItem.java
b/src/main/java/org/apache/commons/fileupload/FileItem.java
index bf423515..c2fb4e16 100644
--- a/src/main/java/org/apache/commons/fileupload/FileItem.java
+++ b/src/main/java/org/apache/commons/fileupload/FileItem.java
@@ -195,7 +195,7 @@ public interface FileItem extends FileItemHeadersSupport {
* be used for storing the contents of the file.
*
* @return An {@link java.io.OutputStream OutputStream} that can be used
- * for storing the contensts of the file.
+ * for storing the contents of the file.
*
* @throws IOException if an error occurs.
*/
diff --git a/src/main/java/org/apache/commons/fileupload/FileUpload.java
b/src/main/java/org/apache/commons/fileupload/FileUpload.java
index 7b843b5c..e26a5a72 100644
--- a/src/main/java/org/apache/commons/fileupload/FileUpload.java
+++ b/src/main/java/org/apache/commons/fileupload/FileUpload.java
@@ -43,7 +43,7 @@ public class FileUpload
// ----------------------------------------------------------- Constructors
/**
- * Constructs an uninitialised instance of this class.
+ * Constructs an uninitialized instance of this class.
*
* A factory must be
* configured, using {@code setFileItemFactory()}, before attempting
diff --git a/src/main/java/org/apache/commons/fileupload/MultipartStream.java
b/src/main/java/org/apache/commons/fileupload/MultipartStream.java
index 34d2e785..6354cfdd 100644
--- a/src/main/java/org/apache/commons/fileupload/MultipartStream.java
+++ b/src/main/java/org/apache/commons/fileupload/MultipartStream.java
@@ -653,7 +653,7 @@ public class MultipartStream {
* @throws IOException if an i/o error occurs.
*/
public boolean skipPreamble() throws IOException {
- // First delimiter may be not preceeded with a CRLF.
+ // First delimiter may be not preceded with a CRLF.
System.arraycopy(boundary, 2, boundary, 0, boundary.length - 2);
boundaryLength = boundary.length - 2;
computeBoundaryTable();
diff --git a/src/main/java/org/apache/commons/fileupload/ParameterParser.java
b/src/main/java/org/apache/commons/fileupload/ParameterParser.java
index 2e4e012c..4dd4b65e 100644
--- a/src/main/java/org/apache/commons/fileupload/ParameterParser.java
+++ b/src/main/java/org/apache/commons/fileupload/ParameterParser.java
@@ -119,7 +119,7 @@ public class ParameterParser {
/**
* Tests if the given character is present in the array of characters.
*
- * @param ch the character to test for presense in the array of characters
+ * @param ch the character to test for presence in the array of characters
* @param charray the array of characters to test against
*
* @return {@code true} if the character is present in the array of
diff --git a/src/main/java/org/apache/commons/fileupload/disk/DiskFileItem.java
b/src/main/java/org/apache/commons/fileupload/disk/DiskFileItem.java
index d255b054..02fb010f 100644
--- a/src/main/java/org/apache/commons/fileupload/disk/DiskFileItem.java
+++ b/src/main/java/org/apache/commons/fileupload/disk/DiskFileItem.java
@@ -436,7 +436,7 @@ public class DiskFileItem
*
* @return The name of the form field.
*
- * @see #setFieldName(java.lang.String)
+ * @see #setFieldName(String)
*
*/
@Override
diff --git
a/src/main/java/org/apache/commons/fileupload/disk/DiskFileItemFactory.java
b/src/main/java/org/apache/commons/fileupload/disk/DiskFileItemFactory.java
index 8434b31a..4cb416b1 100644
--- a/src/main/java/org/apache/commons/fileupload/disk/DiskFileItemFactory.java
+++ b/src/main/java/org/apache/commons/fileupload/disk/DiskFileItemFactory.java
@@ -181,7 +181,7 @@ public class DiskFileItemFactory implements FileItemFactory
{
// --------------------------------------------------------- Public Methods
/**
- * Create a new {@link org.apache.commons.fileupload.disk.DiskFileItem}
+ * Create a new {@link DiskFileItem}
* instance from the supplied parameters and the local factory
* configuration.
*
diff --git
a/src/main/java/org/apache/commons/fileupload/portlet/PortletFileUpload.java
b/src/main/java/org/apache/commons/fileupload/portlet/PortletFileUpload.java
index 3fafbb7c..1d556dbd 100644
--- a/src/main/java/org/apache/commons/fileupload/portlet/PortletFileUpload.java
+++ b/src/main/java/org/apache/commons/fileupload/portlet/PortletFileUpload.java
@@ -67,7 +67,7 @@ public class PortletFileUpload extends FileUpload {
// ----------------------------------------------------------- Constructors
/**
- * Constructs an uninitialised instance of this class. A factory must be
+ * Constructs an uninitialized instance of this class. A factory must be
* configured, using {@code setFileItemFactory()}, before attempting
* to parse requests.
*
diff --git
a/src/main/java/org/apache/commons/fileupload/servlet/ServletFileUpload.java
b/src/main/java/org/apache/commons/fileupload/servlet/ServletFileUpload.java
index 8f1b2bee..648a463a 100644
--- a/src/main/java/org/apache/commons/fileupload/servlet/ServletFileUpload.java
+++ b/src/main/java/org/apache/commons/fileupload/servlet/ServletFileUpload.java
@@ -72,7 +72,7 @@ public class ServletFileUpload extends FileUpload {
// ----------------------------------------------------------- Constructors
/**
- * Constructs an uninitialised instance of this class. A factory must be
+ * Constructs an uninitialized instance of this class. A factory must be
* configured, using {@code setFileItemFactory()}, before attempting
* to parse requests.
*
diff --git
a/src/main/java/org/apache/commons/fileupload/util/FileItemHeadersImpl.java
b/src/main/java/org/apache/commons/fileupload/util/FileItemHeadersImpl.java
index af8427ee..4a9c7941 100644
--- a/src/main/java/org/apache/commons/fileupload/util/FileItemHeadersImpl.java
+++ b/src/main/java/org/apache/commons/fileupload/util/FileItemHeadersImpl.java
@@ -45,9 +45,6 @@ public class FileItemHeadersImpl implements FileItemHeaders,
Serializable {
*/
private final Map<String, List<String>> headerNameToValueListMap = new
LinkedHashMap<String, List<String>>();
- /**
- * {@inheritDoc}
- */
@Override
public String getHeader(final String name) {
final String nameLower = name.toLowerCase(Locale.ENGLISH);
@@ -58,17 +55,11 @@ public class FileItemHeadersImpl implements
FileItemHeaders, Serializable {
return headerValueList.get(0);
}
- /**
- * {@inheritDoc}
- */
@Override
public Iterator<String> getHeaderNames() {
return headerNameToValueListMap.keySet().iterator();
}
- /**
- * {@inheritDoc}
- */
@Override
public Iterator<String> getHeaders(final String name) {
final String nameLower = name.toLowerCase(Locale.ENGLISH);
diff --git
a/src/main/java/org/apache/commons/fileupload/util/mime/MimeUtility.java
b/src/main/java/org/apache/commons/fileupload/util/mime/MimeUtility.java
index af1db7c6..7bfef250 100644
--- a/src/main/java/org/apache/commons/fileupload/util/mime/MimeUtility.java
+++ b/src/main/java/org/apache/commons/fileupload/util/mime/MimeUtility.java
@@ -193,8 +193,8 @@ public final class MimeUtility {
* @param word The possibly encoded word value.
*
* @return The decoded word.
- * @throws ParseException
- * @throws UnsupportedEncodingException
+ * @throws ParseException in case of a parse error of the RFC 2047
+ * @throws UnsupportedEncodingException Thrown when Invalid RFC 2047
encoding was found
*/
private static String decodeWord(final String word) throws ParseException,
UnsupportedEncodingException {
// encoded words start with the characters "=?". If this not an
encoded word, we throw a
diff --git
a/src/main/java/org/apache/commons/fileupload/util/mime/QuotedPrintableDecoder.java
b/src/main/java/org/apache/commons/fileupload/util/mime/QuotedPrintableDecoder.java
index 3b25dd2b..8141a314 100644
---
a/src/main/java/org/apache/commons/fileupload/util/mime/QuotedPrintableDecoder.java
+++
b/src/main/java/org/apache/commons/fileupload/util/mime/QuotedPrintableDecoder.java
@@ -44,7 +44,7 @@ final class QuotedPrintableDecoder {
* @param out The output stream used to return the decoded data.
*
* @return the number of bytes produced.
- * @throws IOException
+ * @throws IOException if an IO error occurs
*/
public static int decode(final byte[] data, final OutputStream out) throws
IOException {
int off = 0;
diff --git
a/src/main/java/org/apache/commons/fileupload/util/mime/RFC2231Utility.java
b/src/main/java/org/apache/commons/fileupload/util/mime/RFC2231Utility.java
index 42bcc340..c3f0f76c 100644
--- a/src/main/java/org/apache/commons/fileupload/util/mime/RFC2231Utility.java
+++ b/src/main/java/org/apache/commons/fileupload/util/mime/RFC2231Utility.java
@@ -20,13 +20,12 @@ import java.io.ByteArrayOutputStream;
import java.io.UnsupportedEncodingException;
/**
* Utility class to decode/encode character set on HTTP Header fields based on
RFC 2231.
- * This implementation adheres to RFC 5987 in particular, which was defined
for HTTP headers
- *
+ * This implementation adheres to RFC 5987 in particular, which was defined
for HTTP headers.
+ * <p>
* RFC 5987 builds on RFC 2231, but has lesser scope like
* <a href="https://tools.ietf.org/html/rfc5987#section-3.2";>mandatory charset
definition</a>
* and <a href="https://tools.ietf.org/html/rfc5987#section-4";>no parameter
continuation</a>
*
- * <p>
* @see <a href="https://tools.ietf.org/html/rfc2231";>RFC 2231</a>
* @see <a href="https://tools.ietf.org/html/rfc5987";>RFC 5987</a>
*/
@@ -93,14 +92,13 @@ public final class RFC2231Utility {
/**
* Decode a string of text obtained from a HTTP header as per RFC 2231
- *
- * <p/>
+ * <p>
* <b>Eg 1.</b> {@code us-ascii'en-us'This%20is%20%2A%2A%2Afun%2A%2A%2A}
* will be decoded to {@code This is ***fun***}
- * <p/>
+ * <p>
* <b>Eg 2.</b> {@code iso-8859-1'en'%A3%20rate}
* will be decoded to {@code £ rate}
- * <p/>
+ * <p>
* <b>Eg 3.</b> {@code UTF-8''%c2%a3%20and%20%e2%82%ac%20rates}
* will be decoded to {@code £ and € rates}
*
