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 465ce65403ad4abfbd33d641b64a7b6953751ce2
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri May 19 10:38:00 2023 -0400
Javadoc
---
.../apache/commons/io/input/UncheckedBufferedReader.java | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git
a/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java
b/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java
index e7273c0b..7c7e9482 100644
--- a/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java
+++ b/src/main/java/org/apache/commons/io/input/UncheckedBufferedReader.java
@@ -22,7 +22,9 @@ import java.io.IOException;
import java.io.Reader;
import java.io.UncheckedIOException;
import java.nio.CharBuffer;
+import java.nio.charset.Charset;
+import org.apache.commons.io.build.AbstractOrigin;
import org.apache.commons.io.build.AbstractStreamBuilder;
import org.apache.commons.io.function.Uncheck;
@@ -66,8 +68,17 @@ public final class UncheckedBufferedReader extends
BufferedReader {
/**
* Constructs a new instance.
+ * <p>
+ * This builder use the aspects Reader, Charset, buffer size.
+ * </p>
+ * <p>
+ * You must provide an origin that can be converted to a Reader by
this builder, otherwise, this call will throw an
+ * {@link UnsupportedOperationException}.
+ * </p>
*
- * @throws UnsupportedOperationException if the origin cannot be
converted to a Reader.
+ * @return a new instance.
+ * @throws UnsupportedOperationException if the origin cannot provide
a Reader.
+ * @see AbstractOrigin#getReader(Charset)
*/
@Override
public UncheckedBufferedReader get() {
