You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@creadur.apache.org by cl...@apache.org on 2026/07/02 16:32:20 UTC
(creadur-rat) 02/02: updated javadoc
This is an automated email from the ASF dual-hosted git repository.
Claudenw pushed a commit to branch create-IODescriptor
in repository https://gitbox.apache.org/repos/asf/creadur-rat.git
commit 4df7a038399ebf576e924b7a84f8dba1c5cf7316
Author: Claude Warren <cl...@xenei.com>
AuthorDate: Thu Jul 2 17:31:56 2026 +0100
updated javadoc
---
.../src/main/java/org/apache/rat/ReportConfiguration.java | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java b/apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java
index bb0b405e..88feadf6 100644
--- a/apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java
+++ b/apache-rat-core/src/main/java/org/apache/rat/ReportConfiguration.java
@@ -887,12 +887,22 @@ public class ReportConfiguration {
return new IODescriptor<>(name, () -> new FileOutputStream(docName.asFile()));
}
+ /**
+ * Creates an output IODescriptor for the file. Does not modify for working directory..
+ * @param file the file to open.
+ * @return the Output IODescriptor.
+ */
static IODescriptor<OutputStream> output(final File file) {
return new IODescriptor<>(file.toString(), () -> new FileOutputStream(file, true));
}
// INPUT CONSTRUCTORS
+ /**
+ * Creates an input IODescriptor for the file. Does not modify for working directory.
+ * @param file the file to open.
+ * @return the Input IODescriptor.
+ */
static IODescriptor<InputStream> input(final File file) {
return new IODescriptor<>(file.toString(), () -> new FileInputStream(file));
}