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 3096b199 Javadoc
3096b199 is described below
commit 3096b1997017397e23c1fa737c43ce95dceb0a92
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Jan 4 12:45:10 2026 -0500
Javadoc
Add an empty line before a Javadoc comment
---
.../fileupload2/core/AbstractRequestContext.java | 1 +
.../fileupload2/core/DeferrableOutputStream.java | 19 +++++++++++++++++++
.../fileupload2/core/FileItemInputIteratorImpl.java | 1 +
.../apache/commons/fileupload2/core/RFC2231Utils.java | 3 +++
4 files changed, 24 insertions(+)
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/AbstractRequestContext.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/AbstractRequestContext.java
index ba263c76..3b81a847 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/AbstractRequestContext.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/AbstractRequestContext.java
@@ -28,6 +28,7 @@ import java.util.regex.Pattern;
* @param <T> The request type.
*/
public abstract class AbstractRequestContext<T> implements RequestContext {
+
/**
* The Content-Type Pattern for multipart/related Requests.
*/
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/DeferrableOutputStream.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/DeferrableOutputStream.java
index f0e6241a..4fe6d3a0 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/DeferrableOutputStream.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/DeferrableOutputStream.java
@@ -60,11 +60,13 @@ import java.util.function.Supplier;
* <a
href="https://issues.apache.org/jira/browse/FILEUPLOAD-295";>FILEUPLOAD-295</a>)
*/
public class DeferrableOutputStream extends OutputStream {
+
/**
* Interface of a listener object, that wishes to be notified about
* state changes.
*/
public interface Listener {
+
/**
* Called, after {@link #persist()} has been invoked,
* and the temporary file has been created.
@@ -74,21 +76,25 @@ public class DeferrableOutputStream extends OutputStream {
*/
default void persisted(final Path path) { }
}
+
/**
* This enumeration represents the possible states of the {@link
DeferrableOutputStream}.
*/
public enum State {
+
/**
* The stream object has been created with a non-negative threshold,
* but so far no data has been written.
*/
initialized,
+
/**
* The stream object has been created with a non-negative threshold,
* and some data has been written, but the threshold is not yet
exceeded,
* and the data is still kept in memory.
*/
opened,
+
/**
* Either of the following conditions is given:
* <ol>
@@ -101,18 +107,21 @@ public class DeferrableOutputStream extends OutputStream {
* written to the temporary file, erasing all existing data from
memory.
*/
persisted,
+
/**
* The stream has been closed, and data can no longer be written. It is
* now valid to invoke {@link DeferrableOutputStream#getInputStream()}.
*/
closed
}
+
/**
* The configured threshold, as an integer. This variable isn't actually
* used. Instead {@link #longThreshold} is used.
* @see #longThreshold
*/
private final int threshold;
+
/**
* The configured threshold, as a long integer. (Using a long integer
* enables proper handling of the threshold, when the file size is
@@ -120,6 +129,7 @@ public class DeferrableOutputStream extends OutputStream {
* @see #threshold
*/
private final long longThreshold;
+
/**
* This supplier will be invoked, if the temporary file is created,
* t
@@ -127,41 +137,49 @@ public class DeferrableOutputStream extends OutputStream {
* @see #path
*/
private final Supplier<Path> pathSupplier;
+
/**
* If a temporary file has been created: Path of the temporary
* file. Otherwise null.
* @see #pathSupplier
*/
private Path path;
+
/**
* If no temporary file was created: A stream, to which the
* incoming data is being written, until the threshold is reached.
* Otherwise null.
*/
private ByteArrayOutputStream baos;
+
/**
* If no temporary file was created, and the stream is closed:
* The in-memory data, that was written to the stream. Otherwise null.
*/
private byte[] bytes;
+
/**
* If a temporary file has been created: An open stream
* for writing to that file. Otherwise null.
*/
private OutputStream out;
+
/**
* The streams current state.
*/
private State state;
+
/**
* True, if the stream has ever been in state {@link State#persisted}.
* Or, in other words: True, if a temporary file has been created.
*/
private boolean wasPersisted;
+
/**
* Number of bytes, that have been written to this stream so far.
*/
private long size;
+
/**
* The configured {@link Listener}, if any, or null.
*/
@@ -387,6 +405,7 @@ public class DeferrableOutputStream extends OutputStream {
if (baos != null) {
baos.writeTo(os);
}
+
/**
* At this point, the output file has been successfully created,
* and we can safely switch state.
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemInputIteratorImpl.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemInputIteratorImpl.java
index 650d0e0a..b936e82a 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemInputIteratorImpl.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/FileItemInputIteratorImpl.java
@@ -32,6 +32,7 @@ import org.apache.commons.io.input.BoundedInputStream;
* The iterator returned by {@link
AbstractFileUpload#getItemIterator(RequestContext)}.
*/
class FileItemInputIteratorImpl implements FileItemInputIterator {
+
/**
* The file uploads processing utility.
*
diff --git
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/RFC2231Utils.java
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/RFC2231Utils.java
index 0641cf16..11c8c749 100644
---
a/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/RFC2231Utils.java
+++
b/commons-fileupload2-core/src/main/java/org/apache/commons/fileupload2/core/RFC2231Utils.java
@@ -36,14 +36,17 @@ final class RFC2231Utils {
* The Hexadecimal values char array.
*/
private static final char[] HEX_DIGITS = "0123456789ABCDEF".toCharArray();
+
/**
* The Hexadecimal representation of 127.
*/
private static final byte MASK = 0x7f;
+
/**
* The Hexadecimal representation of 128.
*/
private static final int MASK_128 = 0x80;
+
/**
* The Hexadecimal decode value.
*/
