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 acb55000 Javadoc
acb55000 is described below
commit acb550005a54a1f37dd3418c22895ce21a723ecb
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Aug 2 15:50:33 2026 -0400
Javadoc
---
.../org/apache/commons/fileupload2/core/DiskFileItem.java | 12 ++++++------
.../java/org/apache/commons/fileupload2/core/FileItem.java | 14 +++++++-------
.../apache/commons/fileupload2/core/MultipartInput.java | 4 ++--
.../commons/fileupload2/core/QuotedPrintableDecoder.java | 4 ++--
.../apache/commons/fileupload2/core/RequestContext.java | 2 +-
.../jakarta/servlet5/JakartaServletRequestContext.java | 2 +-
.../servlet5/JakartaFileUploadFileCountLimitTest.java | 2 +-
.../jakarta/servlet6/JakartaServletRequestContext.java | 2 +-
.../servlet6/JakartaFileUploadFileCountLimitTest.java | 2 +-
.../fileupload2/javax/JavaxServletRequestContext.java | 2 +-
.../javax/JavaxFileUploadFileCountLimitTest.java | 2 +-
.../fileupload2/portlet/JavaxPortletRequestContext.java | 2 +-
12 files changed, 25 insertions(+), 25 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 4dfcab68..2637bbd4 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
@@ -332,7 +332,7 @@ public final class DiskFileItem implements
FileItem<DiskFileItem> {
* Deletes the underlying storage for a file item, including deleting any
associated temporary disk file. This method can be used to ensure that this is
* done at an earlier time, thus preserving system resources.
*
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
@Override
public DiskFileItem delete() throws IOException {
@@ -350,7 +350,7 @@ public final class DiskFileItem implements
FileItem<DiskFileItem> {
* and cached.
*
* @return The contents of the file as an array of bytes or {@code null}
if the data cannot be read.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @throws OutOfMemoryError See {@link Files#readAllBytes(Path)}: If
an array of the required size cannot be allocated, for example the file is
larger
* than {@code 2GB}. If so, you should use
{@link #getInputStream()}.
* @see #getInputStream()
@@ -438,7 +438,7 @@ public final class DiskFileItem implements
FileItem<DiskFileItem> {
* Gets an {@link java.io.InputStream InputStream} that can be used to
retrieve the contents of the file.
*
* @return An {@link java.io.InputStream InputStream} that can be used to
retrieve the contents of the file.
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
@Override
public InputStream getInputStream() throws IOException {
@@ -535,7 +535,7 @@ public final class DiskFileItem implements
FileItem<DiskFileItem> {
* Gets the contents of the file as a String, using the default character
encoding. This method uses {@link #get()} to retrieve the contents of the file.
*
* @return The contents of the file, as a string, if available, or null.
- * @throws IOException if an I/O error occurs
+ * @throws IOException Thrown if an I/O error occurs
* @throws OutOfMemoryError See {@link Files#readAllBytes(Path)}: If a
string of the required size cannot be allocated,
* for example the file is larger than {@code 2GB}. If so, you should
use {@link #getReader()}.
* @throws UnsupportedEncodingException The character set, which is
@@ -553,7 +553,7 @@ public final class DiskFileItem implements
FileItem<DiskFileItem> {
*
* @param charset The charset to use.
* @return The contents of the file, as a string.
- * @throws IOException if an I/O error occurs
+ * @throws IOException Thrown if an I/O error occurs
*/
@Override
public String getString(final Charset charset) throws IOException {
@@ -672,7 +672,7 @@ public final class DiskFileItem implements
FileItem<DiskFileItem> {
* </p>
*
* @param file The {@code File} into which the uploaded item should be
stored.
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
@Override
public DiskFileItem write(final Path file) throws IOException {
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItem.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItem.java
index ecb13e96..415254f0 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItem.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItem.java
@@ -48,7 +48,7 @@ public interface FileItem<F extends FileItem<F>> extends
FileItemHeadersProvider
* earlier time, to preserve resources.
*
* @return {@code this} instance.
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
F delete() throws IOException;
@@ -56,7 +56,7 @@ public interface FileItem<F extends FileItem<F>> extends
FileItemHeadersProvider
* Gets the contents of the file item as a byte array.
*
* @return The contents of the file item as a byte array.
- * @throws IOException if an I/O error occurs
+ * @throws IOException Thrown if an I/O error occurs
*/
byte[] get() throws IOException;
@@ -78,7 +78,7 @@ public interface FileItem<F extends FileItem<F>> extends
FileItemHeadersProvider
* Gets an {@link java.io.InputStream InputStream} that can be used to
retrieve the contents of the file.
*
* @return An {@link java.io.InputStream InputStream} that can be used to
retrieve the contents of the file.
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
InputStream getInputStream() throws IOException;
@@ -96,7 +96,7 @@ public interface FileItem<F extends FileItem<F>> extends
FileItemHeadersProvider
* Gets an {@link java.io.OutputStream OutputStream} that can be used for
storing the contents of the file.
*
* @return An {@link java.io.OutputStream OutputStream} that can be used
for storing the contents of the file.
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
*/
OutputStream getOutputStream() throws IOException;
@@ -113,7 +113,7 @@ public interface FileItem<F extends FileItem<F>> extends
FileItemHeadersProvider
*
* @return The contents of the item, as a string.
*
- * @throws IOException if an I/O error occurs
+ * @throws IOException Thrown if an I/O error occurs
*/
String getString() throws IOException;
@@ -122,7 +122,7 @@ public interface FileItem<F extends FileItem<F>> extends
FileItemHeadersProvider
*
* @param toCharset The character encoding to use.
* @return The contents of the item, as a string.
- * @throws IOException if an I/O error occurs
+ * @throws IOException Thrown if an I/O error occurs
*/
String getString(Charset toCharset) throws IOException;
@@ -168,7 +168,7 @@ public interface FileItem<F extends FileItem<F>> extends
FileItemHeadersProvider
* </p>
*
* @param file The {@code File} into which the uploaded item should be
stored.
- * @throws IOException if an error occurs.
+ * @throws IOException Thrown if an error occurs.
* @return {@code this} instance.
*/
F write(Path file) throws IOException;
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 cf672222..e351b987 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
@@ -890,7 +890,7 @@ public final class MultipartInput {
* Reads a byte from the {@code buffer}, and refills it as necessary.
*
* @return The next byte from the input stream.
- * @throws IOException if there is no more data available.
+ * @throws IOException Thrown if there is no more data available.
*/
public byte readByte() throws IOException {
// Buffer depleted ?
@@ -994,7 +994,7 @@ public final class MultipartInput {
* Finds the beginning of the first {@code encapsulation}.
*
* @return {@code true} if an {@code encapsulation} was found in the
stream.
- * @throws IOException if an i/o error occurs.
+ * @throws IOException Thrown if an i/o error occurs.
*/
public boolean skipPreamble() throws IOException {
// First delimiter may be not preceded with a CRLF.
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 cd77c464..ae2c533b 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
@@ -34,7 +34,7 @@ final class QuotedPrintableDecoder {
* @param data The array of byte data to decode.
* @param out The output stream used to return the decoded data.
* @return The number of bytes produced.
- * @throws IOException if an IO error occurs
+ * @throws IOException Thrown if an IO error occurs
*/
public static int decode(final byte[] data, final OutputStream out) throws
IOException {
var off = 0;
@@ -88,7 +88,7 @@ final class QuotedPrintableDecoder {
*
* @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.
+ * @throws IOException Thrown if the byte is not a valid hexadecimal digit.
*/
private static int hexToBinary(final byte b) throws IOException {
// CHECKSTYLE IGNORE MagicNumber FOR NEXT 1 LINE
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/RequestContext.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/RequestContext.java
index 807d4ae5..b2b890aa 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/RequestContext.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/RequestContext.java
@@ -66,7 +66,7 @@ public interface RequestContext {
* Gets the input stream for the request.
*
* @return The input stream for the request.
- * @throws IOException if a problem occurs.
+ * @throws IOException Thrown if a problem occurs.
*/
InputStream getInputStream() throws IOException;
diff --git
a/commons-fileupload2-jakarta-servlet5/src/main/java/org/apache/commons/fileupload2/jakarta/servlet5/JakartaServletRequestContext.java
b/commons-fileupload2-jakarta-servlet5/src/main/java/org/apache/commons/fileupload2/jakarta/servlet5/JakartaServletRequestContext.java
index e8fd49f6..684bec61 100644
---
a/commons-fileupload2-jakarta-servlet5/src/main/java/org/apache/commons/fileupload2/jakarta/servlet5/JakartaServletRequestContext.java
+++
b/commons-fileupload2-jakarta-servlet5/src/main/java/org/apache/commons/fileupload2/jakarta/servlet5/JakartaServletRequestContext.java
@@ -61,7 +61,7 @@ public class JakartaServletRequestContext extends
AbstractRequestContext<HttpSer
* Gets the input stream for the request.
*
* @return The input stream for the request.
- * @throws IOException if a problem occurs.
+ * @throws IOException Thrown if a problem occurs.
*/
@Override
public InputStream getInputStream() throws IOException {
diff --git
a/commons-fileupload2-jakarta-servlet5/src/test/java/org/apache/commons/fileupload2/jakarta/servlet5/JakartaFileUploadFileCountLimitTest.java
b/commons-fileupload2-jakarta-servlet5/src/test/java/org/apache/commons/fileupload2/jakarta/servlet5/JakartaFileUploadFileCountLimitTest.java
index 9bb64210..7eacc007 100644
---
a/commons-fileupload2-jakarta-servlet5/src/test/java/org/apache/commons/fileupload2/jakarta/servlet5/JakartaFileUploadFileCountLimitTest.java
+++
b/commons-fileupload2-jakarta-servlet5/src/test/java/org/apache/commons/fileupload2/jakarta/servlet5/JakartaFileUploadFileCountLimitTest.java
@@ -60,7 +60,7 @@ class JakartaFileUploadFileCountLimitTest {
* {@code maxFileCount}. The request contains {@code maxFileCount + 1}
files so that the limit is always exceeded.
*
* @param maxFileCount the maximum number of files allowed, set to a
non-default value
- * @throws Exception if the test fails unexpectedly
+ * @throws Exception Thrown if the test fails unexpectedly
*/
@ParameterizedTest
@ValueSource(longs = { 1, 2, 4, 8 })
diff --git
a/commons-fileupload2-jakarta-servlet6/src/main/java/org/apache/commons/fileupload2/jakarta/servlet6/JakartaServletRequestContext.java
b/commons-fileupload2-jakarta-servlet6/src/main/java/org/apache/commons/fileupload2/jakarta/servlet6/JakartaServletRequestContext.java
index f47bc495..5f496689 100644
---
a/commons-fileupload2-jakarta-servlet6/src/main/java/org/apache/commons/fileupload2/jakarta/servlet6/JakartaServletRequestContext.java
+++
b/commons-fileupload2-jakarta-servlet6/src/main/java/org/apache/commons/fileupload2/jakarta/servlet6/JakartaServletRequestContext.java
@@ -61,7 +61,7 @@ public class JakartaServletRequestContext extends
AbstractRequestContext<HttpSer
* Gets the input stream for the request.
*
* @return The input stream for the request.
- * @throws IOException if a problem occurs.
+ * @throws IOException Thrown if a problem occurs.
*/
@Override
public InputStream getInputStream() throws IOException {
diff --git
a/commons-fileupload2-jakarta-servlet6/src/test/java/org/apache/commons/fileupload2/jakarta/servlet6/JakartaFileUploadFileCountLimitTest.java
b/commons-fileupload2-jakarta-servlet6/src/test/java/org/apache/commons/fileupload2/jakarta/servlet6/JakartaFileUploadFileCountLimitTest.java
index 3718be72..06ec5d9d 100644
---
a/commons-fileupload2-jakarta-servlet6/src/test/java/org/apache/commons/fileupload2/jakarta/servlet6/JakartaFileUploadFileCountLimitTest.java
+++
b/commons-fileupload2-jakarta-servlet6/src/test/java/org/apache/commons/fileupload2/jakarta/servlet6/JakartaFileUploadFileCountLimitTest.java
@@ -60,7 +60,7 @@ class JakartaFileUploadFileCountLimitTest {
* {@code maxFileCount}. The request contains {@code maxFileCount + 1}
files so that the limit is always exceeded.
*
* @param maxFileCount the maximum number of files allowed, set to a
non-default value
- * @throws Exception if the test fails unexpectedly
+ * @throws Exception Thrown if the test fails unexpectedly
*/
@ParameterizedTest
@ValueSource(longs = { 1, 2, 4, 8 })
diff --git
a/commons-fileupload2-javax/src/main/java/org/apache/commons/fileupload2/javax/JavaxServletRequestContext.java
b/commons-fileupload2-javax/src/main/java/org/apache/commons/fileupload2/javax/JavaxServletRequestContext.java
index 09f308c8..38db2889 100644
---
a/commons-fileupload2-javax/src/main/java/org/apache/commons/fileupload2/javax/JavaxServletRequestContext.java
+++
b/commons-fileupload2-javax/src/main/java/org/apache/commons/fileupload2/javax/JavaxServletRequestContext.java
@@ -61,7 +61,7 @@ public class JavaxServletRequestContext extends
AbstractRequestContext<HttpServl
* Gets the input stream for the request.
*
* @return The input stream for the request.
- * @throws IOException if a problem occurs.
+ * @throws IOException Thrown if a problem occurs.
*/
@Override
public InputStream getInputStream() throws IOException {
diff --git
a/commons-fileupload2-javax/src/test/java/org/apache/commons/fileupload2/javax/JavaxFileUploadFileCountLimitTest.java
b/commons-fileupload2-javax/src/test/java/org/apache/commons/fileupload2/javax/JavaxFileUploadFileCountLimitTest.java
index ee746fd2..1b409afa 100644
---
a/commons-fileupload2-javax/src/test/java/org/apache/commons/fileupload2/javax/JavaxFileUploadFileCountLimitTest.java
+++
b/commons-fileupload2-javax/src/test/java/org/apache/commons/fileupload2/javax/JavaxFileUploadFileCountLimitTest.java
@@ -60,7 +60,7 @@ class JavaxFileUploadFileCountLimitTest {
* {@code maxFileCount}. The request contains {@code maxFileCount + 1}
files so that the limit is always exceeded.
*
* @param maxFileCount the maximum number of files allowed, set to a
non-default value
- * @throws Exception if the test fails unexpectedly
+ * @throws Exception Thrown if the test fails unexpectedly
*/
@ParameterizedTest
@ValueSource(longs = { 1, 2, 4, 8 })
diff --git
a/commons-fileupload2-portlet/src/main/java/org/apache/commons/fileupload2/portlet/JavaxPortletRequestContext.java
b/commons-fileupload2-portlet/src/main/java/org/apache/commons/fileupload2/portlet/JavaxPortletRequestContext.java
index 95a3dd57..c8810add 100644
---
a/commons-fileupload2-portlet/src/main/java/org/apache/commons/fileupload2/portlet/JavaxPortletRequestContext.java
+++
b/commons-fileupload2-portlet/src/main/java/org/apache/commons/fileupload2/portlet/JavaxPortletRequestContext.java
@@ -61,7 +61,7 @@ public class JavaxPortletRequestContext extends
AbstractRequestContext<ActionReq
* Gets the input stream for the request.
*
* @return The input stream for the request.
- * @throws IOException if a problem occurs.
+ * @throws IOException Thrown if a problem occurs.
*/
@Override
public InputStream getInputStream() throws IOException {
