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 46cbf45aed72973f3467f61a28de8da2a31a8f4f
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri May 19 09:43:18 2023 -0400
Javadoc
---
.../java/org/apache/commons/io/input/BOMInputStream.java | 1 +
.../commons/io/input/BufferedFileChannelInputStream.java | 12 +++++++++++-
.../org/apache/commons/io/input/CharSequenceInputStream.java | 6 +++++-
3 files changed, 17 insertions(+), 2 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
index e48b2c18..d6dedd62 100644
--- a/src/main/java/org/apache/commons/io/input/BOMInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/BOMInputStream.java
@@ -143,6 +143,7 @@ public class BOMInputStream extends ProxyInputStream {
* {@link UnsupportedOperationException}.
* </p>
*
+ * @return a new instance.
* @throws UnsupportedOperationException if the origin cannot provide
an InputStream.
* @see AbstractOrigin#getInputStream(OpenOption...)
*/
diff --git
a/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
b/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
index a29e488d..ea75cc7d 100644
---
a/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
+++
b/src/main/java/org/apache/commons/io/input/BufferedFileChannelInputStream.java
@@ -25,6 +25,7 @@ import java.nio.file.StandardOpenOption;
import java.util.Objects;
import org.apache.commons.io.IOUtils;
+import org.apache.commons.io.build.AbstractOrigin;
import org.apache.commons.io.build.AbstractStreamBuilder;
/**
@@ -71,8 +72,17 @@ public final class BufferedFileChannelInputStream extends
InputStream {
/**
* Constructs a new instance.
+ * <p>
+ * This builder use the aspects Path and buffer size.
+ * </p>
+ * <p>
+ * You must provide an origin that can be converted to a Path by this
builder, otherwise, this call will throw an
+ * {@link UnsupportedOperationException}.
+ * </p>
*
- * @throws UnsupportedOperationException if the origin cannot be
converted to a Path.
+ * @return a new instance.
+ * @throws UnsupportedOperationException if the origin cannot provide
a Path.
+ * @see AbstractOrigin#getPath()
*/
@Override
public BufferedFileChannelInputStream get() throws IOException {
diff --git
a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
index f19ff33a..0c340348 100644
--- a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
@@ -66,8 +66,12 @@ public class CharSequenceInputStream extends InputStream {
/**
* Constructs a new instance.
+ * <p>
+ * This builder use the aspects the buffer size, CharSequence, and
Charset.
+ * </p>
*
- * Uses the buffer size, CharSequence, and Charset aspects.
+ * @return a new instance.
+ * @throws IllegalArgumentException if the buffer is not large enough
to hold a complete character.
*/
@Override
public CharSequenceInputStream get() {
