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-io.git
The following commit(s) were added to refs/heads/master by this push:
new 99357c726 Javadoc
new b0b49492e Merge branch 'master' of
https://gitbox.apache.org/repos/asf/commons-io.git
99357c726 is described below
commit 99357c726c1efbe03b27c9019a0442c4dafc8637
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Jun 11 16:08:49 2024 -0400
Javadoc
---
.../java/org/apache/commons/io/input/ChecksumInputStream.java | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java
b/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java
index e56ba6670..d530edb96 100644
--- a/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ChecksumInputStream.java
@@ -48,7 +48,8 @@ public final class ChecksumInputStream extends
CountingInputStream {
* Builds a new {@link ChecksumInputStream}.
*
* <p>
- * There is no default {@link Checksum}; you MUST provide one.
+ * There is no default {@link Checksum}; you MUST provide one. This avoids
any issue with a default {@link Checksum} being proven deficient or insecure
+ * in the future.
* </p>
* <h2>Using NIO</h2>
* <pre>{@code
@@ -99,8 +100,8 @@ public final class ChecksumInputStream extends
CountingInputStream {
public static class Builder extends
AbstractStreamBuilder<ChecksumInputStream, Builder> {
/**
- * There is no default checksum, you MUST provide one. This avoids any
issue with a default {@link Checksum}
- * being proven deficient or insecure in the future.
+ * There is no default {@link Checksum}, you MUST provide one. This
avoids any issue with a default {@link Checksum} being proven deficient or
insecure
+ * in the future.
*/
private Checksum checksum;
@@ -146,7 +147,8 @@ public final class ChecksumInputStream extends
CountingInputStream {
}
/**
- * Sets the Checksum.
+ * Sets the Checksum. There is no default {@link Checksum}, you MUST
provide one. This avoids any issue with a default {@link Checksum} being proven
+ * deficient or insecure in the future.
*
* @param checksum the Checksum.
* @return {@code this} instance.
