[commons-io] 03/24: Javadoc

[ggregory]

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

commit b0ed879e6d9210a7b0acdf9083e7d6d646f57199
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri May 19 10:37:29 2023 -0400

    Javadoc
---
 .../io/input/MessageDigestCalculatingInputStream.java       | 13 ++++++++++++-
 .../java/org/apache/commons/io/input/QueueInputStream.java  |  8 ++++++++
 2 files changed, 20 insertions(+), 1 deletion(-)

diff --git 
a/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java
 
b/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java
index eea5e941..581da635 100644
--- 
a/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java
+++ 
b/src/main/java/org/apache/commons/io/input/MessageDigestCalculatingInputStream.java
@@ -18,10 +18,12 @@ package org.apache.commons.io.input;
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.nio.file.OpenOption;
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
 import java.security.Provider;
 
+import org.apache.commons.io.build.AbstractOrigin;
 import org.apache.commons.io.build.AbstractStreamBuilder;
 
 /**
@@ -72,8 +74,17 @@ public class MessageDigestCalculatingInputStream extends 
ObservableInputStream {
 
         /**
          * Constructs a new instance.
+         * <p>
+         * This builder use the aspects InputStream and MessageDigest.
+         * </p>
+         * <p>
+         * You must provide an origin that can be converted to an InputStream 
by this builder, otherwise, this call will throw an
+         * {@link UnsupportedOperationException}.
+         * </p>
          *
-         * @throws UnsupportedOperationException if the origin cannot be 
converted to an InputStream.
+         * @return a new instance.
+         * @throws UnsupportedOperationException if the origin cannot provide 
an InputStream.
+         * @see AbstractOrigin#getInputStream(OpenOption...)
          */
         @SuppressWarnings("resource")
         @Override
diff --git a/src/main/java/org/apache/commons/io/input/QueueInputStream.java 
b/src/main/java/org/apache/commons/io/input/QueueInputStream.java
index a0d1f4da..6af18bab 100644
--- a/src/main/java/org/apache/commons/io/input/QueueInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/QueueInputStream.java
@@ -81,6 +81,14 @@ public class QueueInputStream extends InputStream {
         private BlockingQueue<Integer> blockingQueue = new 
LinkedBlockingQueue<>();
         private Duration timeout = Duration.ZERO;
 
+        /**
+         * Constructs a new instance.
+         * <p>
+         * This builder use the aspects BlockingQueue and timeout.
+         * </p>
+         *
+         * @return a new instance.
+         */
         @Override
         public QueueInputStream get() {
             return new QueueInputStream(blockingQueue, timeout);