This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-fileupload.git
The following commit(s) were added to refs/heads/master by this push:
new c4a8492c Javadoc
c4a8492c is described below
commit c4a8492c96ec4d26cb8e14710890ffd1f355b014
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 11:22:12 2026 -0400
Javadoc
---
.../commons/fileupload2/core/DiskFileItem.java | 2 +-
.../commons/fileupload2/core/FileItemFactory.java | 10 ++++----
.../commons/fileupload2/core/FileItemHeaders.java | 4 ++--
.../fileupload2/core/FileItemHeadersProvider.java | 2 +-
.../core/FileUploadContentTypeException.java | 2 +-
.../commons/fileupload2/core/MultipartInput.java | 2 +-
.../commons/fileupload2/core/ParameterParser.java | 28 +++++++++++-----------
.../fileupload2/core/QuotedPrintableDecoder.java | 2 +-
.../servlet5/JakartaMockServletHttpRequest.java | 2 +-
.../servlet6/JakartaMockServletHttpRequest.java | 2 +-
10 files changed, 28 insertions(+), 28 deletions(-)
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/DiskFileItem.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/DiskFileItem.java
index 66aa324e..27ab6ee6 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/DiskFileItem.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/DiskFileItem.java
@@ -591,7 +591,7 @@ public final class DiskFileItem implements
FileItem<DiskFileItem> {
/**
* Sets the default charset for use when no explicit charset parameter is
provided by the sender.
*
- * @param charset the default charset
+ * @param charset The default charset
* @return {@code this} instance.
*/
public DiskFileItem setCharsetDefault(final Charset charset) {
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemFactory.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemFactory.java
index 1ca1051b..e19c22d5 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemFactory.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemFactory.java
@@ -145,7 +145,7 @@ public interface FileItemFactory<I extends FileItem<I>> {
/**
* Sets the content type.
*
- * @param contentType the content type.
+ * @param contentType The content type.
* @return {@code this} instance.
*/
public B setContentType(final String contentType) {
@@ -156,7 +156,7 @@ public interface FileItemFactory<I extends FileItem<I>> {
/**
* Sets the field name.
*
- * @param fieldName the field name.
+ * @param fieldName The field name.
* @return {@code this} instance.
*/
public B setFieldName(final String fieldName) {
@@ -167,7 +167,7 @@ public interface FileItemFactory<I extends FileItem<I>> {
/**
* Sets the file cleaning tracker.
*
- * @param fileCleaningTracker the file cleaning tracker.
+ * @param fileCleaningTracker The file cleaning tracker.
* @return {@code this} instance.
*/
public B setFileCleaningTracker(final FileCleaningTracker
fileCleaningTracker) {
@@ -178,7 +178,7 @@ public interface FileItemFactory<I extends FileItem<I>> {
/**
* Sets the file item headers.
*
- * @param fileItemHeaders the item headers.
+ * @param fileItemHeaders The item headers.
* @return {@code this} instance.
*/
public B setFileItemHeaders(final FileItemHeaders fileItemHeaders) {
@@ -189,7 +189,7 @@ public interface FileItemFactory<I extends FileItem<I>> {
/**
* Sets the file name.
*
- * @param fileName the file name.
+ * @param fileName The file name.
* @return {@code this} instance.
*/
public B setFileName(final String fileName) {
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemHeaders.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemHeaders.java
index b8788702..ca505ee4 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemHeaders.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemHeaders.java
@@ -38,7 +38,7 @@ public interface FileItemHeaders {
* method returns the first header in the item. The header name is case
insensitive.
* </p>
*
- * @param name a {@code String} specifying the header name
+ * @param name A {@code String} specifying the header name
* @return A {@code String} containing the value of the requested header,
or {@code null} if the item does not have a header of that name
*/
String getHeader(String name);
@@ -57,7 +57,7 @@ public interface FileItemHeaders {
* If the item did not include any headers of the specified name, this
method returns an empty {@code Iterator}. The header name is case insensitive.
* </p>
*
- * @param name a {@code String} specifying the header name
+ * @param name A {@code String} specifying the header name
* @return An {@code Iterator} containing the values of the requested
header. If the item does not have any headers of that name, return an empty
* {@code Iterator}
*/
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemHeadersProvider.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemHeadersProvider.java
index ff3f776c..4d1d2400 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemHeadersProvider.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemHeadersProvider.java
@@ -36,7 +36,7 @@ public interface FileItemHeadersProvider<T extends
FileItemHeadersProvider<T>> {
* Sets the headers read from within an item. Implementations of {@link
FileItem} or {@link FileItemInput} should implement this interface to be able
to get
* the raw headers found within the item header block.
*
- * @param headers the instance that holds onto the headers for this
instance.
+ * @param headers The instance that holds onto the headers for this
instance.
* @return {@code this} instance.
*/
T setHeaders(FileItemHeaders headers);
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileUploadContentTypeException.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileUploadContentTypeException.java
index 86d88e69..76beca71 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileUploadContentTypeException.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileUploadContentTypeException.java
@@ -46,7 +46,7 @@ public class FileUploadContentTypeException extends
FileUploadException {
* Constructs an instance with the specified detail message and cause.
*
* @param message The detail message (which is saved for later retrieval
by the {@link #getMessage()} method)
- * @param cause the original cause
+ * @param cause The original cause
*/
public FileUploadContentTypeException(final String message, final
Throwable cause) {
super(message, cause);
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/MultipartInput.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/MultipartInput.java
index 1ae454f5..cf672222 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/MultipartInput.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/MultipartInput.java
@@ -155,7 +155,7 @@ public final class MultipartInput {
/**
* Sets the boundary.
*
- * @param boundary the boundary.
+ * @param boundary The boundary.
* @return {@code this} instance.
*/
public Builder setBoundary(final byte[] boundary) {
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/ParameterParser.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/ParameterParser.java
index 4a5ccbe2..419c4689 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/ParameterParser.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/ParameterParser.java
@@ -117,8 +117,8 @@ public class ParameterParser {
/**
* Tests if the given character is present 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
+ * @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
characters, {@code false} otherwise.
*/
private boolean isOneOf(final char ch, final char[] charray) {
@@ -135,8 +135,8 @@ public class ParameterParser {
/**
* Parses a map of name/value pairs from the given array of characters.
Names are expected to be unique.
*
- * @param charArray the array of characters that contains a sequence of
name/value pairs
- * @param separator the name/value pairs separator
+ * @param charArray The array of characters that contains a sequence of
name/value pairs
+ * @param separator The name/value pairs separator
* @return A map of name/value pairs
*/
public Map<String, String> parse(final char[] charArray, final char
separator) {
@@ -149,10 +149,10 @@ public class ParameterParser {
/**
* Parses a map of name/value pairs from the given array of characters.
Names are expected to be unique.
*
- * @param charArray the array of characters that contains a sequence of
name/value pairs
- * @param offset the initial offset.
- * @param length the length.
- * @param separator the name/value pairs separator
+ * @param charArray The array of characters that contains a sequence of
name/value pairs
+ * @param offset The initial offset.
+ * @param length The length.
+ * @param separator The name/value pairs separator
* @return A map of name/value pairs
*/
public Map<String, String> parse(final char[] charArray, final int offset,
final int length, final char separator) {
@@ -201,8 +201,8 @@ public class ParameterParser {
/**
* Parses a map of name/value pairs from the given string. Names are
expected to be unique.
*
- * @param str the string that contains a sequence of name/value pairs
- * @param separator the name/value pairs separator
+ * @param str The string that contains a sequence of name/value pairs
+ * @param separator The name/value pairs separator
* @return A map of name/value pairs
*/
public Map<String, String> parse(final String str, final char separator) {
@@ -216,8 +216,8 @@ public class ParameterParser {
* Parses a map of name/value pairs from the given string. Names are
expected to be unique. Multiple separators may be specified and the earliest
found in
* the input string is used.
*
- * @param str the string that contains a sequence of name/value
pairs
- * @param separators the name/value pairs separators
+ * @param str The string that contains a sequence of name/value
pairs
+ * @param separators The name/value pairs separators
* @return A map of name/value pairs
*/
public Map<String, String> parse(final String str, final char[]
separators) {
@@ -241,7 +241,7 @@ public class ParameterParser {
/**
* Parses out a token until any of the given terminators is encountered
outside the quotation marks.
*
- * @param terminators the array of terminating characters. Any of these
characters when encountered outside the quotation marks signify the end of the
token
+ * @param terminators The array of terminating characters. Any of these
characters when encountered outside the quotation marks signify the end of the
token
* @return The token
*/
private String parseQuotedToken(final char[] terminators) {
@@ -269,7 +269,7 @@ public class ParameterParser {
/**
* Parses out a token until any of the given terminators is encountered.
*
- * @param terminators the array of terminating characters. Any of these
characters when encountered signify the end of the token
+ * @param terminators The array of terminating characters. Any of these
characters when encountered signify the end of the token
* @return The token
*/
private String parseToken(final char[] terminators) {
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/QuotedPrintableDecoder.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/QuotedPrintableDecoder.java
index c54f9a0c..cd77c464 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/QuotedPrintableDecoder.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/QuotedPrintableDecoder.java
@@ -86,7 +86,7 @@ final class QuotedPrintableDecoder {
/**
* Converts a hexadecimal digit to the binary value it represents.
*
- * @param b the ASCII hexadecimal byte to convert (0-0, A-F, a-f)
+ * @param b The ASCII hexadecimal byte to convert (0-0, A-F, a-f)
* @return The int value of the hexadecimal byte, 0-15
* @throws IOException if the byte is not a valid hexadecimal digit.
*/
diff --git
a/commons-fileupload2-jakarta-servlet5/src/test/java/org/apache/commons/fileupload2/jakarta/servlet5/JakartaMockServletHttpRequest.java
b/commons-fileupload2-jakarta-servlet5/src/test/java/org/apache/commons/fileupload2/jakarta/servlet5/JakartaMockServletHttpRequest.java
index 7053331f..8d9be365 100644
---
a/commons-fileupload2-jakarta-servlet5/src/test/java/org/apache/commons/fileupload2/jakarta/servlet5/JakartaMockServletHttpRequest.java
+++
b/commons-fileupload2-jakarta-servlet5/src/test/java/org/apache/commons/fileupload2/jakarta/servlet5/JakartaMockServletHttpRequest.java
@@ -633,7 +633,7 @@ public class JakartaMockServletHttpRequest implements
HttpServletRequest {
/**
* Sets the read limit. This can be used to limit the number of bytes to
read ahead.
*
- * @param readLimit the read limit to use
+ * @param readLimit The read limit to use
*/
public void setReadLimit(final int readLimit) {
this.readLimit = readLimit;
diff --git
a/commons-fileupload2-jakarta-servlet6/src/test/java/org/apache/commons/fileupload2/jakarta/servlet6/JakartaMockServletHttpRequest.java
b/commons-fileupload2-jakarta-servlet6/src/test/java/org/apache/commons/fileupload2/jakarta/servlet6/JakartaMockServletHttpRequest.java
index c89ed56a..4f62ddc6 100644
---
a/commons-fileupload2-jakarta-servlet6/src/test/java/org/apache/commons/fileupload2/jakarta/servlet6/JakartaMockServletHttpRequest.java
+++
b/commons-fileupload2-jakarta-servlet6/src/test/java/org/apache/commons/fileupload2/jakarta/servlet6/JakartaMockServletHttpRequest.java
@@ -626,7 +626,7 @@ public class JakartaMockServletHttpRequest implements
HttpServletRequest {
/**
* Sets the read limit. This can be used to limit the number of bytes to
read ahead.
*
- * @param readLimit the read limit to use
+ * @param readLimit The read limit to use
*/
public void setReadLimit(final int readLimit) {
this.readLimit = readLimit;
