You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/05/19 14:39:58 UTC
[commons-io] 14/24: Javadoc
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 f55f6a090af3dcc8030f3c85e3d694c0d8047a9d
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri May 19 10:38:19 2023 -0400
Javadoc
---
.../commons/io/input/UnsynchronizedFilterInputStream.java | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/input/UnsynchronizedFilterInputStream.java b/src/main/java/org/apache/commons/io/input/UnsynchronizedFilterInputStream.java
index 1f43ad18..698f42d8 100644
--- a/src/main/java/org/apache/commons/io/input/UnsynchronizedFilterInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/UnsynchronizedFilterInputStream.java
@@ -20,7 +20,9 @@ package org.apache.commons.io.input;
import java.io.FilterInputStream;
import java.io.IOException;
import java.io.InputStream;
+import java.nio.file.OpenOption;
+import org.apache.commons.io.build.AbstractOrigin;
import org.apache.commons.io.build.AbstractStreamBuilder;
/**
@@ -66,8 +68,17 @@ public class UnsynchronizedFilterInputStream extends InputStream {
/**
* 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>
*
- * @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