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

    Javadoc
---
 .../commons/io/input/UncheckedFilterInputStream.java     | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git 
a/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java 
b/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java
index cd0e40f7..05414782 100644
--- a/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/UncheckedFilterInputStream.java
@@ -22,7 +22,9 @@ import java.io.FilterInputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.UncheckedIOException;
+import java.nio.file.OpenOption;
 
+import org.apache.commons.io.build.AbstractOrigin;
 import org.apache.commons.io.build.AbstractStreamBuilder;
 import org.apache.commons.io.function.Uncheck;
 
@@ -60,6 +62,20 @@ public final class UncheckedFilterInputStream extends 
FilterInputStream {
      */
     public static class Builder extends 
AbstractStreamBuilder<UncheckedFilterInputStream, Builder> {
 
+        /**
+         * Constructs a new instance.
+         * <p>
+         * This builder use the aspect InputStream.
+         * </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>
+         *
+         * @return a new instance.
+         * @throws UnsupportedOperationException if the origin cannot provide 
an InputStream.
+         * @see AbstractOrigin#getInputStream(OpenOption...)
+         */
         @Override
         public UncheckedFilterInputStream get() {
             // This an unchecked class, so this method is as well.