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 8e18451793430a7b18594bec92dbab16379bae92
Author: Gary Gregory <[email protected]>
AuthorDate: Fri May 19 10:37:52 2023 -0400

    Javadoc
---
 .../org/apache/commons/io/input/ReversedLinesFileReader.java | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git 
a/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java 
b/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java
index 52576f58..75052f55 100644
--- a/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java
+++ b/src/main/java/org/apache/commons/io/input/ReversedLinesFileReader.java
@@ -36,6 +36,7 @@ import java.util.List;
 import org.apache.commons.io.Charsets;
 import org.apache.commons.io.FileSystem;
 import org.apache.commons.io.StandardLineSeparator;
+import org.apache.commons.io.build.AbstractOrigin;
 import org.apache.commons.io.build.AbstractStreamBuilder;
 
 /**
@@ -72,8 +73,17 @@ public class ReversedLinesFileReader implements Closeable {
 
         /**
          * Constructs a new instance.
+         * <p>
+         * This builder use the aspects Path, Charset, 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 ReversedLinesFileReader get() throws IOException {

Reply via email to