[commons-io] 12/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 193f7d07ca459a3e88aba0b457d4caf4b1cd11e6
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri May 19 10:38:11 2023 -0400

    Javadoc
---
 .../commons/io/input/UnsynchronizedBufferedInputStream.java | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git 
a/src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java
 
b/src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java
index ad544368..1034609c 100644
--- 
a/src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java
+++ 
b/src/main/java/org/apache/commons/io/input/UnsynchronizedBufferedInputStream.java
@@ -20,8 +20,10 @@ package org.apache.commons.io.input;
 import java.io.BufferedInputStream;
 import java.io.IOException;
 import java.io.InputStream;
+import java.nio.file.OpenOption;
 
 import org.apache.commons.io.IOUtils;
+import org.apache.commons.io.build.AbstractOrigin;
 import org.apache.commons.io.build.AbstractStreamBuilder;
 
 /**
@@ -79,8 +81,17 @@ public final class UnsynchronizedBufferedInputStream extends 
UnsynchronizedFilte
 
         /**
          * Constructs a new instance.
+         * <p>
+         * This builder use the aspects InputStream and buffer size.
+         * </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") // Caller closes.
         @Override