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 ebb73c7 Javadoc
ebb73c7 is described below
commit ebb73c713f95f97e8c88787168e9b3b45a3880cb
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Jun 11 09:26:01 2023 -0400
Javadoc
---
.../org/apache/commons/fileupload2/package-info.java | 17 +++++++++--------
.../commons/fileupload2/jakarta/package-info.java | 4 ++--
.../apache/commons/fileupload2/javax/package-info.java | 6 +++---
.../commons/fileupload2/portlet/package-info.java | 6 +++---
4 files changed, 17 insertions(+), 16 deletions(-)
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 6b90a36..3ad42bc 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,11 +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 FileUpload FileUpload} such as
+ * the provided extensions of {@link
org.apache.commons.fileupload2.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 FileItem FileItem} instances, such as {@link DiskFileItemFactory
- * DiskFileItemFactory}.
+ * {@link org.apache.commons.fileupload2.FileItem} instances, such as {@link
org.apache.commons.fileupload2.disk.DiskFileItemFactory}.
* </p>
* <p>
* The following is a brief example of typical usage in a servlet, storing the
uploaded files on disk.
@@ -34,11 +33,13 @@
*
* <pre>
* public void doPost(HttpServletRequest req, HttpServletResponse res) {
- * DiskFileItemFactory factory = new DiskFileItemFactory();
- * // maximum size that will be stored in memory
- * factory.setSizeThreshold(4096);
- * // the location for saving data that is larger than getSizeThreshold()
- * factory.setRepository(new File("/tmp"));
+ * DiskFileItemFactory factory = new DiskFileItemFactory.builder()
+ * // maximum size that will be stored in memory
+ * .setSizeThreshold(4096);
+ * // the location for saving data that is larger than getSizeThreshold()
+ * .setPath(Paths.get("/tmp"))
+ * // build it
+ * .get();
*
* ServletFileUpload upload = new ServletFileUpload(factory);
* // maximum size before a FileUploadException will be thrown
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 b7d5f7f..72afa84 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 FileUpload FileUpload} for use in servlets
conforming to the namespace {@code jakarta.servlet}.
+ * An implementation of {@link org.apache.commons.fileupload2.FileUpload} for
use in servlets conforming to the namespace {@code jakarta.servlet}.
*
* </p>
* <p>
@@ -25,7 +25,7 @@
* </p>
*
* <pre>
- * DiskFileItemFactory factory = new DiskFileItemFactory();
+ * DiskFileItemFactory factory = new DiskFileItemFactory().builder().get();
* // Configure the factory here, if desired.
* JakSrvltFileUpload upload = new JakSrvltFileUpload(factory);
* // Configure the uploader here, if desired.
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 5059607..67f7ca6 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,16 +17,16 @@
/**
* <p>
- * An implementation of {@link FileUpload FileUpload} for use in servlets
conforming to JSR 53. This implementation requires only
+ * An implementation of {@link org.apache.commons.fileupload2.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 DiskFileItemFactory DiskFileItemFactory}.
+ * implementation, such as {@link
org.apache.commons.fileupload2.disk.DiskFileItemFactory}.
* </p>
* <p>
* The following code fragment demonstrates typical usage.
* </p>
*
* <pre>
- * DiskFileItemFactory factory = new DiskFileItemFactory();
+ * DiskFileItemFactory factory = new DiskFileItemFactory().builder().get();
* // Configure the factory here, if desired.
* ServletFileUpload upload = new ServletFileUpload(factory);
* // Configure the uploader here, if desired.
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 d68fbef..e63ae96 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 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 DiskFileItemFactory DiskFileItemFactory}.
+ * An implementation of {@link org.apache.commons.fileupload2.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}
+ * implementation, such as {@link
org.apache.commons.fileupload2.disk.DiskFileItemFactory}.
* </p>
* <p>
* The following code fragment demonstrates typical usage.
