This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/main by this push:
new 6e0385bb59 Align with Commons File Upload 1.x and make @since tags
project specific
6e0385bb59 is described below
commit 6e0385bb59d457cacfa7fb63ad44ef5e45a86351
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Thu Apr 4 12:48:27 2024 +0100
Align with Commons File Upload 1.x and make @since tags project specific
---
java/org/apache/tomcat/util/http/fileupload/FileItem.java | 2 +-
.../tomcat/util/http/fileupload/FileItemHeaders.java | 2 +-
.../util/http/fileupload/FileItemHeadersSupport.java | 2 +-
java/org/apache/tomcat/util/http/fileupload/FileUtils.java | 4 ++--
java/org/apache/tomcat/util/http/fileupload/IOUtils.java | 14 +++++++-------
.../tomcat/util/http/fileupload/MultipartStream.java | 3 +--
.../apache/tomcat/util/http/fileupload/RequestContext.java | 2 +-
.../apache/tomcat/util/http/fileupload/UploadContext.java | 4 ++--
.../tomcat/util/http/fileupload/disk/DiskFileItem.java | 2 +-
.../util/http/fileupload/disk/DiskFileItemFactory.java | 2 +-
.../http/fileupload/impl/InvalidContentTypeException.java | 2 +-
.../tomcat/util/http/fileupload/impl/SizeException.java | 4 ++--
.../http/fileupload/servlet/ServletRequestContext.java | 2 +-
.../util/http/fileupload/util/FileItemHeadersImpl.java | 2 +-
.../tomcat/util/http/fileupload/util/mime/MimeUtility.java | 2 +-
.../util/http/fileupload/util/mime/ParseException.java | 2 +-
.../http/fileupload/util/mime/QuotedPrintableDecoder.java | 2 +-
17 files changed, 26 insertions(+), 27 deletions(-)
diff --git a/java/org/apache/tomcat/util/http/fileupload/FileItem.java
b/java/org/apache/tomcat/util/http/fileupload/FileItem.java
index d1e0523f12..e6f035fc7b 100644
--- a/java/org/apache/tomcat/util/http/fileupload/FileItem.java
+++ b/java/org/apache/tomcat/util/http/fileupload/FileItem.java
@@ -43,7 +43,7 @@ import java.io.UnsupportedEncodingException;
* implementation of this interface to also implement
* {@code javax.activation.DataSource} with minimal additional work.
*
- * @since 1.3 additionally implements FileItemHeadersSupport
+ * @since FileUpload 1.3 additionally implements FileItemHeadersSupport
*/
public interface FileItem extends FileItemHeadersSupport {
diff --git a/java/org/apache/tomcat/util/http/fileupload/FileItemHeaders.java
b/java/org/apache/tomcat/util/http/fileupload/FileItemHeaders.java
index bcfd40c588..890f4397ae 100644
--- a/java/org/apache/tomcat/util/http/fileupload/FileItemHeaders.java
+++ b/java/org/apache/tomcat/util/http/fileupload/FileItemHeaders.java
@@ -23,7 +23,7 @@ import java.util.Iterator;
* item that was received within a {@code multipart/form-data} POST
* request.</p>
*
- * @since 1.2.1
+ * @since FileUpload 1.2.1
*/
public interface FileItemHeaders {
diff --git
a/java/org/apache/tomcat/util/http/fileupload/FileItemHeadersSupport.java
b/java/org/apache/tomcat/util/http/fileupload/FileItemHeadersSupport.java
index 3e98dbb2f0..e5858c7177 100644
--- a/java/org/apache/tomcat/util/http/fileupload/FileItemHeadersSupport.java
+++ b/java/org/apache/tomcat/util/http/fileupload/FileItemHeadersSupport.java
@@ -20,7 +20,7 @@ package org.apache.tomcat.util.http.fileupload;
* Interface that will indicate that {@link FileItem} or {@link FileItemStream}
* implementations will accept the headers read for the item.
*
- * @since 1.2.1
+ * @since FileUpload 1.2.1
*
* @see FileItem
* @see FileItemStream
diff --git a/java/org/apache/tomcat/util/http/fileupload/FileUtils.java
b/java/org/apache/tomcat/util/http/fileupload/FileUtils.java
index 53e0489cf7..a325fb62a6 100644
--- a/java/org/apache/tomcat/util/http/fileupload/FileUtils.java
+++ b/java/org/apache/tomcat/util/http/fileupload/FileUtils.java
@@ -258,7 +258,7 @@ public class FileUtils {
* @param file file with parent to create, must not be {@code null}
* @throws NullPointerException if the file is {@code null}
* @throws IOException if the parent directory cannot be created
- * @since 2.5
+ * @since IO 2.5
*/
public static void forceMkdirParent(final File file) throws IOException {
final File parent = file.getParentFile();
@@ -282,7 +282,7 @@ public class FileUtils {
* @param file the file to check
* @return true if the file is a Symbolic Link
* @throws IOException if an IO error occurs while checking the file
- * @since 2.0
+ * @since IO 2.0
*/
public static boolean isSymlink(File file) throws IOException {
if (file == null) {
diff --git a/java/org/apache/tomcat/util/http/fileupload/IOUtils.java
b/java/org/apache/tomcat/util/http/fileupload/IOUtils.java
index 069b0aeb00..0941653ebd 100644
--- a/java/org/apache/tomcat/util/http/fileupload/IOUtils.java
+++ b/java/org/apache/tomcat/util/http/fileupload/IOUtils.java
@@ -60,7 +60,7 @@ public class IOUtils {
/**
* Represents the end-of-file (or stream).
- * @since 2.5 (made public)
+ * @since IO 2.5 (made public)
*/
public static final int EOF = -1;
@@ -104,7 +104,7 @@ public class IOUtils {
* </pre>
*
* @param closeable the objects to close, may be null or already closed
- * @since 2.0
+ * @since IO 2.0
*/
public static void closeQuietly(final Closeable closeable) {
try {
@@ -135,7 +135,7 @@ public class IOUtils {
* @return the number of bytes copied, or -1 if > Integer.MAX_VALUE
* @throws NullPointerException if the input or output is null
* @throws IOException if an I/O error occurs
- * @since 1.1
+ * @since IO 1.1
*/
public static int copy(final InputStream input, final OutputStream output)
throws IOException {
final long count = copyLarge(input, output);
@@ -159,7 +159,7 @@ public class IOUtils {
* @return the number of bytes copied
* @throws NullPointerException if the input or output is null
* @throws IOException if an I/O error occurs
- * @since 1.3
+ * @since IO 1.3
*/
public static long copyLarge(final InputStream input, final OutputStream
output)
throws IOException {
@@ -186,7 +186,7 @@ public class IOUtils {
* @param length length to read, must be >= 0
* @return actual length read; may be less than requested if EOF was
reached
* @throws IOException if a read error occurs
- * @since 2.2
+ * @since IO 2.2
*/
public static int read(final InputStream input, final byte[] buffer, final
int offset, final int length)
throws IOException {
@@ -219,7 +219,7 @@ public class IOUtils {
* @throws IOException if there is a problem reading the file
* @throws IllegalArgumentException if length is negative
* @throws EOFException if the number of bytes read was
incorrect
- * @since 2.2
+ * @since IO 2.2
*/
public static void readFully(final InputStream input, final byte[] buffer,
final int offset, final int length)
throws IOException {
@@ -241,7 +241,7 @@ public class IOUtils {
* @throws IOException if there is a problem reading the file
* @throws IllegalArgumentException if length is negative
* @throws EOFException if the number of bytes read was
incorrect
- * @since 2.2
+ * @since IO 2.2
*/
public static void readFully(final InputStream input, final byte[] buffer)
throws IOException {
readFully(input, buffer, 0, buffer.length);
diff --git a/java/org/apache/tomcat/util/http/fileupload/MultipartStream.java
b/java/org/apache/tomcat/util/http/fileupload/MultipartStream.java
index 179673654c..0c76e66955 100644
--- a/java/org/apache/tomcat/util/http/fileupload/MultipartStream.java
+++ b/java/org/apache/tomcat/util/http/fileupload/MultipartStream.java
@@ -26,7 +26,6 @@ import
org.apache.tomcat.util.http.fileupload.impl.FileUploadIOException;
import org.apache.tomcat.util.http.fileupload.util.Closeable;
import org.apache.tomcat.util.http.fileupload.util.Streams;
-
/**
* <p> Low level API for processing file uploads.
*
@@ -284,7 +283,7 @@ public class MultipartStream {
*
* @throws IllegalArgumentException If the buffer size is too small
*
- * @since 1.3.1
+ * @since FileUpload 1.3.1
*/
public MultipartStream(final InputStream input,
final byte[] boundary,
diff --git a/java/org/apache/tomcat/util/http/fileupload/RequestContext.java
b/java/org/apache/tomcat/util/http/fileupload/RequestContext.java
index 9c00856032..8fb222ce2b 100644
--- a/java/org/apache/tomcat/util/http/fileupload/RequestContext.java
+++ b/java/org/apache/tomcat/util/http/fileupload/RequestContext.java
@@ -24,7 +24,7 @@ import java.io.InputStream;
* interface should be implemented for each type of request that may be
* handled by FileUpload, such as servlets and portlets.</p>
*
- * @since 1.1
+ * @since FileUpload 1.1
*/
public interface RequestContext {
diff --git a/java/org/apache/tomcat/util/http/fileupload/UploadContext.java
b/java/org/apache/tomcat/util/http/fileupload/UploadContext.java
index 4fc3bf7bc8..28076774ea 100644
--- a/java/org/apache/tomcat/util/http/fileupload/UploadContext.java
+++ b/java/org/apache/tomcat/util/http/fileupload/UploadContext.java
@@ -24,7 +24,7 @@ package org.apache.tomcat.util.http.fileupload;
* and it might vanish for a refactored 2.x version moving the new method into
* RequestContext again.
*
- * @since 1.3
+ * @since FileUpload 1.3
*/
public interface UploadContext extends RequestContext {
@@ -32,7 +32,7 @@ public interface UploadContext extends RequestContext {
* Retrieve the content length of the request.
*
* @return The content length of the request.
- * @since 1.3
+ * @since FileUpload 1.3
*/
long contentLength();
diff --git a/java/org/apache/tomcat/util/http/fileupload/disk/DiskFileItem.java
b/java/org/apache/tomcat/util/http/fileupload/disk/DiskFileItem.java
index c0a2bd8617..dfdca9d426 100644
--- a/java/org/apache/tomcat/util/http/fileupload/disk/DiskFileItem.java
+++ b/java/org/apache/tomcat/util/http/fileupload/disk/DiskFileItem.java
@@ -56,7 +56,7 @@ import org.apache.tomcat.util.http.fileupload.util.Streams;
* <p>Temporary files, which are created for file items, will be deleted when
* the associated request is recycled.</p>
*
- * @since 1.1
+ * @since FileUpload 1.1
*/
public class DiskFileItem
implements FileItem {
diff --git
a/java/org/apache/tomcat/util/http/fileupload/disk/DiskFileItemFactory.java
b/java/org/apache/tomcat/util/http/fileupload/disk/DiskFileItemFactory.java
index ce1eec2f24..8b0073da3f 100644
--- a/java/org/apache/tomcat/util/http/fileupload/disk/DiskFileItemFactory.java
+++ b/java/org/apache/tomcat/util/http/fileupload/disk/DiskFileItemFactory.java
@@ -54,7 +54,7 @@ import org.apache.tomcat.util.http.fileupload.FileItemFactory;
* <p>Temporary files, which are created for file items, will be deleted when
* the associated request is recycled.</p>
*
- * @since 1.1
+ * @since FileUpload 1.1
*/
public class DiskFileItemFactory implements FileItemFactory {
diff --git
a/java/org/apache/tomcat/util/http/fileupload/impl/InvalidContentTypeException.java
b/java/org/apache/tomcat/util/http/fileupload/impl/InvalidContentTypeException.java
index 547349feb2..699a32326f 100644
---
a/java/org/apache/tomcat/util/http/fileupload/impl/InvalidContentTypeException.java
+++
b/java/org/apache/tomcat/util/http/fileupload/impl/InvalidContentTypeException.java
@@ -53,7 +53,7 @@ public class InvalidContentTypeException
* @param msg The detail message.
* @param cause the original cause
*
- * @since 1.3.1
+ * @since FileUpload 1.3.1
*/
public InvalidContentTypeException(final String msg, final Throwable
cause) {
super(msg, cause);
diff --git
a/java/org/apache/tomcat/util/http/fileupload/impl/SizeException.java
b/java/org/apache/tomcat/util/http/fileupload/impl/SizeException.java
index eaed75fd3a..35f25efbc7 100644
--- a/java/org/apache/tomcat/util/http/fileupload/impl/SizeException.java
+++ b/java/org/apache/tomcat/util/http/fileupload/impl/SizeException.java
@@ -56,7 +56,7 @@ public abstract class SizeException extends
FileUploadException {
* Retrieves the actual size of the request.
*
* @return The actual size of the request.
- * @since 1.3
+ * @since FileUpload 1.3
*/
public long getActualSize() {
return actual;
@@ -66,7 +66,7 @@ public abstract class SizeException extends
FileUploadException {
* Retrieves the permitted size of the request.
*
* @return The permitted size of the request.
- * @since 1.3
+ * @since FileUpload 1.3
*/
public long getPermittedSize() {
return permitted;
diff --git
a/java/org/apache/tomcat/util/http/fileupload/servlet/ServletRequestContext.java
b/java/org/apache/tomcat/util/http/fileupload/servlet/ServletRequestContext.java
index 3eb51f9a9a..90f05d1f78 100644
---
a/java/org/apache/tomcat/util/http/fileupload/servlet/ServletRequestContext.java
+++
b/java/org/apache/tomcat/util/http/fileupload/servlet/ServletRequestContext.java
@@ -76,7 +76,7 @@ public class ServletRequestContext implements UploadContext {
* Retrieve the content length of the request.
*
* @return The content length of the request.
- * @since 1.3
+ * @since FileUpload 1.3
*/
@Override
public long contentLength() {
diff --git
a/java/org/apache/tomcat/util/http/fileupload/util/FileItemHeadersImpl.java
b/java/org/apache/tomcat/util/http/fileupload/util/FileItemHeadersImpl.java
index f9ebb31677..a70345ff43 100644
--- a/java/org/apache/tomcat/util/http/fileupload/util/FileItemHeadersImpl.java
+++ b/java/org/apache/tomcat/util/http/fileupload/util/FileItemHeadersImpl.java
@@ -30,7 +30,7 @@ import org.apache.tomcat.util.http.fileupload.FileItemHeaders;
/**
* Default implementation of the {@link FileItemHeaders} interface.
*
- * @since 1.2.1
+ * @since FileUpload 1.2.1
*/
public class FileItemHeadersImpl implements FileItemHeaders, Serializable {
diff --git
a/java/org/apache/tomcat/util/http/fileupload/util/mime/MimeUtility.java
b/java/org/apache/tomcat/util/http/fileupload/util/mime/MimeUtility.java
index 70a4fb3b45..d55151401e 100644
--- a/java/org/apache/tomcat/util/http/fileupload/util/mime/MimeUtility.java
+++ b/java/org/apache/tomcat/util/http/fileupload/util/mime/MimeUtility.java
@@ -29,7 +29,7 @@ import org.apache.tomcat.util.codec.binary.Base64;
/**
* Utility class to decode MIME texts.
*
- * @since 1.3
+ * @since FileUpload 1.3
*/
public final class MimeUtility {
diff --git
a/java/org/apache/tomcat/util/http/fileupload/util/mime/ParseException.java
b/java/org/apache/tomcat/util/http/fileupload/util/mime/ParseException.java
index bf31a539aa..72e9896fe6 100644
--- a/java/org/apache/tomcat/util/http/fileupload/util/mime/ParseException.java
+++ b/java/org/apache/tomcat/util/http/fileupload/util/mime/ParseException.java
@@ -17,7 +17,7 @@
package org.apache.tomcat.util.http.fileupload.util.mime;
/**
- * @since 1.3
+ * @since FileUpload 1.3
*/
final class ParseException extends Exception {
diff --git
a/java/org/apache/tomcat/util/http/fileupload/util/mime/QuotedPrintableDecoder.java
b/java/org/apache/tomcat/util/http/fileupload/util/mime/QuotedPrintableDecoder.java
index 3a563b948d..6a94f3c202 100644
---
a/java/org/apache/tomcat/util/http/fileupload/util/mime/QuotedPrintableDecoder.java
+++
b/java/org/apache/tomcat/util/http/fileupload/util/mime/QuotedPrintableDecoder.java
@@ -20,7 +20,7 @@ import java.io.IOException;
import java.io.OutputStream;
/**
- * @since 1.3
+ * @since FileUpload 1.3
*/
final class QuotedPrintableDecoder {
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
