This is an automated email from the ASF dual-hosted git repository.
ggregory 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 03356ab Javadoc
03356ab is described below
commit 03356ab982803b8a0521a54bb7e63c5f056949b2
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jun 10 08:43:11 2023 -0400
Javadoc
---
.../java/org/apache/commons/fileupload2/AbstractFileUpload.java | 2 +-
.../src/main/java/org/apache/commons/fileupload2/FileItem.java | 2 +-
.../src/main/java/org/apache/commons/fileupload2/FileUpload.java | 2 +-
.../main/java/org/apache/commons/fileupload2/disk/DiskFileItem.java | 4 ++--
.../org/apache/commons/fileupload2/disk/DiskFileItemFactory.java | 2 +-
.../main/java/org/apache/commons/fileupload2/disk/package-info.java | 6 +++---
.../src/main/java/org/apache/commons/fileupload2/package-info.java | 4 ++--
.../org/apache/commons/fileupload2/DiskFileItemSerializeTest.java | 2 +-
.../commons/fileupload2/jakarta/JakartaServletFileUpload.java | 2 +-
.../java/org/apache/commons/fileupload2/jakarta/package-info.java | 2 +-
.../apache/commons/fileupload2/javax/JavaxServletFileUpload.java | 2 +-
.../java/org/apache/commons/fileupload2/javax/package-info.java | 6 +++---
.../apache/commons/fileupload2/portlet/JavaxPortletFileUpload.java | 4 ++--
.../java/org/apache/commons/fileupload2/portlet/package-info.java | 6 +++---
14 files changed, 23 insertions(+), 23 deletions(-)
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/AbstractFileUpload.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/AbstractFileUpload.java
index fae053b..ca845c4 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/AbstractFileUpload.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/AbstractFileUpload.java
@@ -34,7 +34,7 @@ import org.apache.commons.io.IOUtils;
* <p>
* This class handles multiple files per single HTML widget, sent using {@code
multipart/mixed} encoding type, as specified by
* <a href="http://www.ietf.org/rfc/rfc1867.txt";>RFC 1867</a>. Use {@link
#parseRequest(RequestContext)} to acquire a list of
- * {@link org.apache.commons.fileupload2.FileItem}s associated with a given
HTML widget.
+ * {@link FileItem}s associated with a given HTML widget.
* </p>
* <p>
* How the data for individual parts is stored is determined by the factory
used to create them; a given part may be in memory, on disk, or somewhere else.
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/FileItem.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/FileItem.java
index d20a2cc..a264dcb 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/FileItem.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/FileItem.java
@@ -28,7 +28,7 @@ import java.nio.file.Path;
* This class represents a file or form item that was received within a {@code
multipart/form-data} POST request.
* </p>
* <p>
- * After retrieving an instance of this class from a {@link
org.apache.commons.fileupload2.FileUpload FileUpload} instance (see
+ * After retrieving an instance of this class from a {@link FileUpload
FileUpload} instance (see
* {@code org.apache.commons.fileupload2.servlet.ServletFileUpload
#parseRequest(javax.servlet.http.HttpServletRequest)}), you may either request
all contents
* of the file at once using {@link #get()} or request an {@link InputStream}
with {@link #getInputStream()} and process the file without
* attempting to load it into memory, which may come handy with large files.
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/FileUpload.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/FileUpload.java
index ed8e9ef..a8c3fd5 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/FileUpload.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/FileUpload.java
@@ -25,7 +25,7 @@ import java.util.Map;
* <p>
* This class handles multiple files per single HTML widget, sent using {@code
multipart/mixed} encoding type, as specified by
* <a href="http://www.ietf.org/rfc/rfc1867.txt";>RFC 1867</a>. Use {@link
#parseRequest(RequestContext)} to acquire a list of
- * {@link org.apache.commons.fileupload2.FileItem} associated with a given
HTML widget.
+ * {@link FileItem} associated with a given HTML widget.
* </p>
* <p>
* How the data for individual parts is stored is determined by the factory
used to create them; a given part may be in memory, on disk, or somewhere else.
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItem.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItem.java
index 9208bc7..0d08c59 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItem.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItem.java
@@ -44,7 +44,7 @@ import org.apache.commons.io.function.Uncheck;
import org.apache.commons.io.output.DeferredFileOutputStream;
/**
- * The default implementation of the {@link
org.apache.commons.fileupload2.FileItem FileItem} interface.
+ * The default implementation of the {@link FileItem FileItem} interface.
*
* <p>
* After retrieving an instance of this class from a {@link
DiskFileItemFactory} instance (see {@code
org.apache.commons.fileupload2.servlet.ServletFileUpload
@@ -319,7 +319,7 @@ public class DiskFileItem implements FileItem {
* @return The original file name in the client's file system.
* @throws org.apache.commons.fileupload2.InvalidFileNameException The
file name contains a NUL character, which might be an indicator of a security
attack.
* If you
intend to use the file name anyways, catch the exception and use
- * {@link
org.apache.commons.fileupload2.InvalidFileNameException#getName()}.
+ * {@link
InvalidFileNameException#getName()}.
*/
@Override
public String getName() {
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItemFactory.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItemFactory.java
index 4d68090..a95f8f4 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItemFactory.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/disk/DiskFileItemFactory.java
@@ -149,7 +149,7 @@ public final class DiskFileItemFactory implements
FileItemFactory {
}
/**
- * Creates a new {@link org.apache.commons.fileupload2.disk.DiskFileItem}
instance from the supplied parameters and the local factory configuration.
+ * Creates a new {@link disk.DiskFileItem} instance from the supplied
parameters and the local factory configuration.
*
* @param fieldName The name of the form field.
* @param contentType The content type of the form field.
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/disk/package-info.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/disk/package-info.java
index 1bc8e86..6449cff 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/disk/package-info.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/disk/package-info.java
@@ -17,12 +17,12 @@
/**
* <p>
- * A disk-based implementation of the {@link
org.apache.commons.fileupload2.FileItem FileItem} interface. This
implementation retains smaller items in memory,
+ * A disk-based implementation of the {@link FileItem FileItem} interface.
This implementation retains smaller items in memory,
* while writing larger ones to disk. The threshold between these two is
configurable, as is the location of files that are written to disk.
* </p>
* <p>
- * In typical usage, an instance of {@link
org.apache.commons.fileupload2.disk.DiskFileItemFactory DiskFileItemFactory}
would be created, configured, and then
- * passed to a {@link org.apache.commons.fileupload2.FileUpload FileUpload}
implementation such as
+ * In typical usage, an instance of {@link disk.DiskFileItemFactory
DiskFileItemFactory} would be created, configured, and then
+ * passed to a {@link FileUpload FileUpload} implementation such as
* {@code org.apache.commons.fileupload2.servlet.ServletFileUpload
ServletFileUpload} or
* {@code org.apache.commons.fileupload2.portlet.PortletFileUpload
PortletFileUpload}.
* </p>
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/package-info.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/package-info.java
index de11820..e0cfc1e 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/package-info.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/package-info.java
@@ -22,10 +22,10 @@
* </p>
* <p>
* While this package provides the generic functionality for file uploads,
these classes are not typically used directly. Instead, normal usage involves
one of
- * the provided extensions of {@link org.apache.commons.fileupload2.FileUpload
FileUpload} such as
+ * the provided extensions of {@link FileUpload FileUpload} such as
* {@code org.apache.commons.fileupload2.servlet.ServletFileUpload
ServletFileUpload} or
* {@code org.apache.commons.fileupload2.portlet.PortletFileUpload
PortletFileUpload}, together with a factory for
- * {@link org.apache.commons.fileupload2.FileItem FileItem} instances, such as
{@link org.apache.commons.fileupload2.disk.DiskFileItemFactory
+ * {@link FileItem FileItem} instances, such as {@link disk.DiskFileItemFactory
* DiskFileItemFactory}.
* </p>
* <p>
diff --git
a/commons-fileupload2-core/src/test/java/org/apache/commons/fileupload2/DiskFileItemSerializeTest.java
b/commons-fileupload2-core/src/test/java/org/apache/commons/fileupload2/DiskFileItemSerializeTest.java
index a2a87d7..7dd08e1 100644
---
a/commons-fileupload2-core/src/test/java/org/apache/commons/fileupload2/DiskFileItemSerializeTest.java
+++
b/commons-fileupload2-core/src/test/java/org/apache/commons/fileupload2/DiskFileItemSerializeTest.java
@@ -40,7 +40,7 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
/**
- * Serialization Unit tests for {@link
org.apache.commons.fileupload2.disk.DiskFileItem}.
+ * Serialization Unit tests for {@link disk.DiskFileItem}.
*/
public class DiskFileItemSerializeTest {
diff --git
a/commons-fileupload2-jakarta/src/main/java/org/apache/commons/fileupload2/jakarta/JakartaServletFileUpload.java
b/commons-fileupload2-jakarta/src/main/java/org/apache/commons/fileupload2/jakarta/JakartaServletFileUpload.java
index 52cac30..1f62ac8 100644
---
a/commons-fileupload2-jakarta/src/main/java/org/apache/commons/fileupload2/jakarta/JakartaServletFileUpload.java
+++
b/commons-fileupload2-jakarta/src/main/java/org/apache/commons/fileupload2/jakarta/JakartaServletFileUpload.java
@@ -34,7 +34,7 @@ import jakarta.servlet.http.HttpServletRequest;
* <p>
* This class handles multiple files per single HTML widget, sent using {@code
multipart/mixed} encoding type, as specified by
* <a href="http://www.ietf.org/rfc/rfc1867.txt";>RFC 1867</a>. Use {@link
#parseRequest(HttpServletRequest)} to acquire a list of
- * {@link org.apache.commons.fileupload2.FileItem}s associated with a given
HTML widget.
+ * {@link FileItem}s associated with a given HTML widget.
* </p>
* <p>
* How the data for individual parts is stored is determined by the factory
used to create them; a given part may be in memory, on disk, or somewhere else.
diff --git
a/commons-fileupload2-jakarta/src/main/java/org/apache/commons/fileupload2/jakarta/package-info.java
b/commons-fileupload2-jakarta/src/main/java/org/apache/commons/fileupload2/jakarta/package-info.java
index 2aa1fdf..b7d5f7f 100644
---
a/commons-fileupload2-jakarta/src/main/java/org/apache/commons/fileupload2/jakarta/package-info.java
+++
b/commons-fileupload2-jakarta/src/main/java/org/apache/commons/fileupload2/jakarta/package-info.java
@@ -17,7 +17,7 @@
/**
* <p>
- * An implementation of {@link org.apache.commons.fileupload2.FileUpload
FileUpload} for use in servlets conforming to the namespace {@code
jakarta.servlet}.
+ * An implementation of {@link FileUpload FileUpload} for use in servlets
conforming to the namespace {@code jakarta.servlet}.
*
* </p>
* <p>
diff --git
a/commons-fileupload2-javax/src/main/java/org/apache/commons/fileupload2/javax/JavaxServletFileUpload.java
b/commons-fileupload2-javax/src/main/java/org/apache/commons/fileupload2/javax/JavaxServletFileUpload.java
index ea1879e..389ec0b 100644
---
a/commons-fileupload2-javax/src/main/java/org/apache/commons/fileupload2/javax/JavaxServletFileUpload.java
+++
b/commons-fileupload2-javax/src/main/java/org/apache/commons/fileupload2/javax/JavaxServletFileUpload.java
@@ -34,7 +34,7 @@ import org.apache.commons.fileupload2.FileUploadException;
* <p>
* This class handles multiple files per single HTML widget, sent using {@code
multipart/mixed} encoding type, as specified by
* <a href="http://www.ietf.org/rfc/rfc1867.txt";>RFC 1867</a>. Use {@link
#parseRequest(HttpServletRequest)} to acquire a list of
- * {@link org.apache.commons.fileupload2.FileItem}s associated with a given
HTML widget.
+ * {@link FileItem}s associated with a given HTML widget.
* </p>
* <p>
* How the data for individual parts is stored is determined by the factory
used to create them; a given part may be in memory, on disk, or somewhere else.
diff --git
a/commons-fileupload2-javax/src/main/java/org/apache/commons/fileupload2/javax/package-info.java
b/commons-fileupload2-javax/src/main/java/org/apache/commons/fileupload2/javax/package-info.java
index c79ebae..c2f6521 100644
---
a/commons-fileupload2-javax/src/main/java/org/apache/commons/fileupload2/javax/package-info.java
+++
b/commons-fileupload2-javax/src/main/java/org/apache/commons/fileupload2/javax/package-info.java
@@ -17,9 +17,9 @@
/**
* <p>
- * An implementation of {@link org.apache.commons.fileupload2.FileUpload
FileUpload} for use in servlets conforming to JSR 53. This implementation
requires only
- * access to the servlet's current {@code HttpServletRequest} instance, and a
suitable {@link org.apache.commons.fileupload2.FileItemFactory FileItemFactory}
- * implementation, such as {@link
org.apache.commons.fileupload2.disk.DiskFileItemFactory DiskFileItemFactory}.
+ * An implementation of {@link FileUpload FileUpload} for use in servlets
conforming to JSR 53. This implementation requires only
+ * access to the servlet's current {@code HttpServletRequest} instance, and a
suitable {@link FileItemFactory FileItemFactory}
+ * implementation, such as {@link disk.DiskFileItemFactory
DiskFileItemFactory}.
* </p>
* <p>
* The following code fragment demonstrates typical usage.
diff --git
a/commons-fileupload2-portlet/src/main/java/org/apache/commons/fileupload2/portlet/JavaxPortletFileUpload.java
b/commons-fileupload2-portlet/src/main/java/org/apache/commons/fileupload2/portlet/JavaxPortletFileUpload.java
index 9d896f4..8efb934 100644
---
a/commons-fileupload2-portlet/src/main/java/org/apache/commons/fileupload2/portlet/JavaxPortletFileUpload.java
+++
b/commons-fileupload2-portlet/src/main/java/org/apache/commons/fileupload2/portlet/JavaxPortletFileUpload.java
@@ -33,8 +33,8 @@ import org.apache.commons.fileupload2.FileUploadException;
* High level API for processing file uploads.
* <p>
* This class handles multiple files per single HTML widget, sent using {@code
multipart/mixed} encoding type, as specified by
- * <a href="http://www.ietf.org/rfc/rfc1867.txt";>RFC 1867</a>. Use {@link
org.apache.commons.fileupload2.javax.JavaxServletFileUpload
- * #parseRequest(javax.servlet.http.HttpServletRequest)} to acquire a list of
{@link org.apache.commons.fileupload2.FileItem FileItems} associated with a
given
+ * <a href="http://www.ietf.org/rfc/rfc1867.txt";>RFC 1867</a>. Use {@link
javax.JavaxServletFileUpload
+ * #parseRequest(javax.servlet.http.HttpServletRequest)} to acquire a list of
{@link FileItem FileItems} associated with a given
* HTML widget.
* </p>
* <p>
diff --git
a/commons-fileupload2-portlet/src/main/java/org/apache/commons/fileupload2/portlet/package-info.java
b/commons-fileupload2-portlet/src/main/java/org/apache/commons/fileupload2/portlet/package-info.java
index 0d24735..0d8ebdd 100644
---
a/commons-fileupload2-portlet/src/main/java/org/apache/commons/fileupload2/portlet/package-info.java
+++
b/commons-fileupload2-portlet/src/main/java/org/apache/commons/fileupload2/portlet/package-info.java
@@ -17,9 +17,9 @@
/**
* <p>
- * An implementation of {@link org.apache.commons.fileupload2.FileUpload
FileUpload} for use in portlets conforming to JSR 168. This implementation
requires
- * only access to the portlet's current {@code ActionRequest} instance, and a
suitable {@link org.apache.commons.fileupload2.FileItemFactory FileItemFactory}
- * implementation, such as {@link
org.apache.commons.fileupload2.disk.DiskFileItemFactory DiskFileItemFactory}.
+ * An implementation of {@link FileUpload FileUpload} for use in portlets
conforming to JSR 168. This implementation requires
+ * only access to the portlet's current {@code ActionRequest} instance, and a
suitable {@link FileItemFactory FileItemFactory}
+ * implementation, such as {@link disk.DiskFileItemFactory
DiskFileItemFactory}.
* </p>
* <p>
* The following code fragment demonstrates typical usage.
