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 ade8cba11c11282dac641cb3d484987540ebcfd2
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Fri May 19 10:38:42 2023 -0400
Javadoc
---
.../java/org/apache/commons/io/output/LockableFileWriter.java | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/output/LockableFileWriter.java
b/src/main/java/org/apache/commons/io/output/LockableFileWriter.java
index 5cbb70ee..052fc4ca 100644
--- a/src/main/java/org/apache/commons/io/output/LockableFileWriter.java
+++ b/src/main/java/org/apache/commons/io/output/LockableFileWriter.java
@@ -77,8 +77,17 @@ public class LockableFileWriter extends Writer {
/**
* Constructs a new instance.
+ * <p>
+ * This builder use the aspects File, Charset, append, and
lockDirectory.
+ * </p>
+ * <p>
+ * 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 UnsupportedOperationException if the origin cannot provide
a File.
+ * @see AbstractOrigin#getFile()
*/
@Override
public LockableFileWriter get() throws IOException {
