You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/06/11 21:33:13 UTC
[commons-fileupload] 01/04: Javadoc
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
commit e73b58369eb4c0e780567e4d015111bd92449557
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Jun 11 15:09:47 2023 -0400
Javadoc
Inline single use variable
---
.../org/apache/commons/fileupload2/AbstractFileUpload.java | 6 +++---
.../org/apache/commons/fileupload2/FileItemFactory.java | 11 +----------
.../org/apache/commons/fileupload2/disk/DiskFileItem.java | 14 ++++++++++----
.../commons/fileupload2/disk/DiskFileItemFactory.java | 6 ++++--
.../apache/commons/fileupload2/AbstractFileUploadTest.java | 12 ++++++------
.../fileupload2/disk/DiskFileItemSerializeTest.java | 11 +++++++----
6 files changed, 31 insertions(+), 29 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 bd5f566..7c30e6e 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
@@ -401,15 +401,15 @@ public abstract class AbstractFileUpload {
/**
* Parses an <a href="http://www.ietf.org/rfc/rfc1867.txt">RFC 1867</a> compliant {@code multipart/form-data} stream.
*
- * @param ctx The context for the request to be parsed.
+ * @param requestContext The context for the request to be parsed.
* @return A list of {@code FileItem} instances parsed from the request, in the order that they were transmitted.
* @throws FileUploadException if there are problems reading/parsing the request or storing files.
*/
- public List<FileItem> parseRequest(final RequestContext ctx) throws FileUploadException {
+ public List<FileItem> parseRequest(final RequestContext requestContext) throws FileUploadException {
final List<FileItem> itemList = new ArrayList<>();
boolean successful = false;
try {
- final FileItemIterator iter = getItemIterator(ctx);
+ final FileItemIterator iter = getItemIterator(requestContext);
final FileItemFactory fileItemFactory = Objects.requireNonNull(getFileItemFactory(), "No FileItemFactory has been set.");
final byte[] buffer = new byte[IOUtils.DEFAULT_BUFFER_SIZE];
while (iter.hasNext()) {
diff --git a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/FileItemFactory.java b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/FileItemFactory.java
index ebb130d..bdb48d6 100644
--- a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/FileItemFactory.java
+++ b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/FileItemFactory.java
@@ -16,7 +16,6 @@
*/
package org.apache.commons.fileupload2;
-import org.apache.commons.fileupload2.disk.DiskFileItem;
import org.apache.commons.fileupload2.disk.DiskFileItemFactory;
import org.apache.commons.io.FileCleaningTracker;
import org.apache.commons.io.build.AbstractStreamBuilder;
@@ -31,15 +30,7 @@ import org.apache.commons.io.file.PathUtils;
public interface FileItemFactory {
/**
- * Builds a new {@link DiskFileItem} instance.
- * <p>
- * For example:
- * </p>
- *
- * <pre>{@code
- * DiskFileItem diskFileItem = DiskFileItem.builder().get();
- * }
- * </pre>
+ * Abstracts building for subclasses.
*
* @param <T> the type of instances to build.
* @param <B> the type of builder subclass.
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 6600877..baa968b 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
@@ -74,7 +74,16 @@ public final class DiskFileItem implements FileItem {
* </p>
*
* <pre>{@code
- * DiskFileItem diskFileItem = DiskFileItem.builder().get();
+ * <pre>{@code
+ * final FileItem fileItem = fileItemFactory.fileItemBuilder()
+ * .setFieldName("FieldName")
+ * .setContentType("ContentType")
+ * .setFormField(true)
+ * .setFileName("FileName")
+ * .setFileItemHeaders(...)
+ * .get();
+ * }
+ * </pre>
* }
* </pre>
*/
@@ -90,9 +99,6 @@ public final class DiskFileItem implements FileItem {
/**
* Constructs a new instance.
* <p>
- * This builder use the superclass aspects Path (repository) and buffer size (threshold).
- * </p>
- * <p>
* You must provide an origin that can be converted to a Reader by this builder, otherwise, this call will throw an
* {@link UnsupportedOperationException}.
* </p>
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 19f1fc1..4f0646c 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
@@ -64,9 +64,11 @@ public final class DiskFileItemFactory implements FileItemFactory {
* <p>
* For example:
* </p>
- *
* <pre>{@code
- * DiskFileItemFactory factory = DiskFileItemFactory.builder().setPath(path).setBufferSize(DEFAULT_THRESHOLD).get();
+ * DiskFileItemFactory factory = DiskFileItemFactory.builder()
+ * .setPath(path)
+ * .setBufferSize(DEFAULT_THRESHOLD)
+ * .get();
* }
* </pre>
*/
diff --git a/commons-fileupload2-core/src/test/java/org/apache/commons/fileupload2/AbstractFileUploadTest.java b/commons-fileupload2-core/src/test/java/org/apache/commons/fileupload2/AbstractFileUploadTest.java
index 4077abb..4cef95c 100644
--- a/commons-fileupload2-core/src/test/java/org/apache/commons/fileupload2/AbstractFileUploadTest.java
+++ b/commons-fileupload2-core/src/test/java/org/apache/commons/fileupload2/AbstractFileUploadTest.java
@@ -82,12 +82,12 @@ public abstract class AbstractFileUploadTest<T extends FileUpload<?>> extends Ab
assertTrue(field.isFormField());
assertEquals("Joe Blow", field.getString());
- final FileItem file = fileItems.get(1);
- assertEquals("pics", file.getFieldName());
- assertFalse(file.isFormField());
- assertEquals("... contents of file1.txt ...", file.getString());
- assertEquals("text/plain", file.getContentType());
- assertEquals("file1.txt", file.getName());
+ final FileItem fileItem = fileItems.get(1);
+ assertEquals("pics", fileItem.getFieldName());
+ assertFalse(fileItem.isFormField());
+ assertEquals("... contents of file1.txt ...", fileItem.getString());
+ assertEquals("text/plain", fileItem.getContentType());
+ assertEquals("file1.txt", fileItem.getName());
}
/**
diff --git a/commons-fileupload2-core/src/test/java/org/apache/commons/fileupload2/disk/DiskFileItemSerializeTest.java b/commons-fileupload2-core/src/test/java/org/apache/commons/fileupload2/disk/DiskFileItemSerializeTest.java
index 19b8bff..6063bc9 100644
--- a/commons-fileupload2-core/src/test/java/org/apache/commons/fileupload2/disk/DiskFileItemSerializeTest.java
+++ b/commons-fileupload2-core/src/test/java/org/apache/commons/fileupload2/disk/DiskFileItemSerializeTest.java
@@ -100,12 +100,15 @@ public class DiskFileItemSerializeTest {
* Create a FileItem with the specfied content bytes and repository.
*/
private FileItem createFileItem(final byte[] contentBytes, final Path repository) throws IOException {
- final FileItemFactory factory = DiskFileItemFactory.builder().setBufferSize(THRESHOLD).setPath(repository).get();
- final String textFieldName = "textField";
-
+ // @formatter:off
+ final FileItemFactory factory = DiskFileItemFactory.builder()
+ .setBufferSize(THRESHOLD)
+ .setPath(repository)
+ .get();
+ // @formatter:on
// @formatter:off
final FileItem item = factory.fileItemBuilder()
- .setFieldName(textFieldName)
+ .setFieldName("textField")
.setContentType(TEXT_CONTENT_TYPE)
.setFormField(true)
.setFileName("My File Name")