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 184c7095680baee90f5390ff113616d90d03ce39
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri May 19 10:37:34 2023 -0400
Javadoc
---
.../commons/io/input/RandomAccessFileInputStream.java | 14 +++++++++++++-
1 file changed, 13 insertions(+), 1 deletion(-)
diff --git
a/src/main/java/org/apache/commons/io/input/RandomAccessFileInputStream.java
b/src/main/java/org/apache/commons/io/input/RandomAccessFileInputStream.java
index 0fb7849c..36a36ecd 100644
--- a/src/main/java/org/apache/commons/io/input/RandomAccessFileInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/RandomAccessFileInputStream.java
@@ -23,6 +23,7 @@ import java.io.RandomAccessFile;
import java.util.Objects;
import org.apache.commons.io.RandomAccessFileMode;
+import org.apache.commons.io.build.AbstractOrigin;
import org.apache.commons.io.build.AbstractStreamBuilder;
/**
@@ -55,8 +56,19 @@ public class RandomAccessFileInputStream extends InputStream
{
/**
* Constructs a new instance.
+ * <p>
+ * This builder use the aspects RandomAccessFile or File, and
closeOnClose. Only set one of RandomAccessFile or an origin that can be
converted to a
+ * File.
+ * </p>
+ * <p>
+ * If RandomAccessFile is not set, then you must provide an origin
that can be converted to a File by this builder, otherwise, this call will
throw an
+ * {@link UnsupportedOperationException}.
+ * </p>
*
- * @throws UnsupportedOperationException if the origin cannot be
converted to a File.
+ * @return a new instance.
+ * @throws IllegalStateException if both RandomAccessFile and origin
are set.
+ * @throws UnsupportedOperationException if the origin cannot provide
a File.
+ * @see AbstractOrigin#getFile()
*/
@SuppressWarnings("resource") // Caller closes depending on settings
@Override
