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 6ce2028bea59ebecbec2e32cfcb36991fcd5d8d8
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Dec 10 16:29:55 2024 -0500
Javadoc: Add missing constructor Javadoc comments
---
src/main/java/org/apache/commons/io/FileCleaner.java | 7 +++++++
.../java/org/apache/commons/io/FileCleaningTracker.java | 7 +++++++
.../java/org/apache/commons/io/build/AbstractOrigin.java | 2 +-
.../apache/commons/io/build/AbstractOriginSupplier.java | 7 +++++++
.../org/apache/commons/io/build/AbstractStreamBuilder.java | 7 +++++++
.../java/org/apache/commons/io/build/AbstractSupplier.java | 7 +++++++
.../commons/io/comparator/DirectoryFileComparator.java | 7 +++++++
.../commons/io/comparator/LastModifiedFileComparator.java | 7 +++++++
.../org/apache/commons/io/input/ClosedInputStream.java | 7 +++++++
.../java/org/apache/commons/io/input/ClosedReader.java | 7 +++++++
.../java/org/apache/commons/io/input/DemuxInputStream.java | 7 +++++++
.../org/apache/commons/io/input/ObservableInputStream.java | 14 ++++++++++++++
.../commons/io/monitor/FileAlterationListenerAdaptor.java | 7 +++++++
.../org/apache/commons/io/output/ClosedOutputStream.java | 7 +++++++
.../java/org/apache/commons/io/output/ClosedWriter.java | 7 +++++++
.../org/apache/commons/io/output/DemuxOutputStream.java | 8 ++++++++
16 files changed, 114 insertions(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/io/FileCleaner.java
b/src/main/java/org/apache/commons/io/FileCleaner.java
index d748e2578..de52c793a 100644
--- a/src/main/java/org/apache/commons/io/FileCleaner.java
+++ b/src/main/java/org/apache/commons/io/FileCleaner.java
@@ -155,4 +155,11 @@ public class FileCleaner {
public static void track(final String path, final Object marker, final
FileDeleteStrategy deleteStrategy) {
INSTANCE.track(path, marker, deleteStrategy);
}
+
+ /**
+ * Construct a new instance.
+ */
+ public FileCleaner() {
+ // empty
+ }
}
diff --git a/src/main/java/org/apache/commons/io/FileCleaningTracker.java
b/src/main/java/org/apache/commons/io/FileCleaningTracker.java
index 02de332b9..28ade287c 100644
--- a/src/main/java/org/apache/commons/io/FileCleaningTracker.java
+++ b/src/main/java/org/apache/commons/io/FileCleaningTracker.java
@@ -156,6 +156,13 @@ public class FileCleaningTracker {
*/
Thread reaper;
+ /**
+ * Construct a new instance.
+ */
+ public FileCleaningTracker() {
+ // empty
+ }
+
/**
* Adds a tracker to the list of trackers.
*
diff --git a/src/main/java/org/apache/commons/io/build/AbstractOrigin.java
b/src/main/java/org/apache/commons/io/build/AbstractOrigin.java
index 6cc5c725e..e74bab1a0 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractOrigin.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractOrigin.java
@@ -605,7 +605,7 @@ public abstract class AbstractOrigin<T, B extends
AbstractOrigin<T, B>> extends
final T origin;
/**
- * Constructs a new instance for a subclass.
+ * Constructs a new instance for subclasses.
*
* @param origin The origin.
*/
diff --git
a/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
b/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
index 768514cd9..c9b3138de 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java
@@ -187,6 +187,13 @@ public abstract class AbstractOriginSupplier<T, B extends
AbstractOriginSupplier
*/
private AbstractOrigin<?, ?> origin;
+ /**
+ * Constructs a new instance for subclasses.
+ */
+ public AbstractOriginSupplier() {
+ // empty
+ }
+
/**
* Checks whether the origin is null.
*
diff --git
a/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
b/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
index a8e5bcdb6..e50235c69 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractStreamBuilder.java
@@ -83,6 +83,13 @@ public abstract class AbstractStreamBuilder<T, B extends
AbstractStreamBuilder<T
*/
private IntUnaryOperator bufferSizeChecker = defaultSizeChecker;
+ /**
+ * Constructs a new instance for subclasses.
+ */
+ public AbstractStreamBuilder() {
+ // empty
+ }
+
/**
* Applies the buffer size request.
*
diff --git a/src/main/java/org/apache/commons/io/build/AbstractSupplier.java
b/src/main/java/org/apache/commons/io/build/AbstractSupplier.java
index 84daedce2..05899a2e1 100644
--- a/src/main/java/org/apache/commons/io/build/AbstractSupplier.java
+++ b/src/main/java/org/apache/commons/io/build/AbstractSupplier.java
@@ -124,6 +124,13 @@ import org.apache.commons.io.function.IOSupplier;
*/
public abstract class AbstractSupplier<T, B extends AbstractSupplier<T, B>>
implements IOSupplier<T> {
+ /**
+ * Constructs a new instance for subclasses.
+ */
+ public AbstractSupplier() {
+ // empty
+ }
+
/**
* Returns this instance typed as the subclass type {@code B}.
* <p>
diff --git
a/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java
b/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java
index cedf0b1ea..1c737d220 100644
---
a/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java
+++
b/src/main/java/org/apache/commons/io/comparator/DirectoryFileComparator.java
@@ -63,6 +63,13 @@ public class DirectoryFileComparator extends
AbstractFileComparator implements S
/** Singleton reverse default comparator instance */
public static final Comparator<File> DIRECTORY_REVERSE = new
ReverseFileComparator(DIRECTORY_COMPARATOR);
+ /**
+ * Construct a new instance.
+ */
+ public DirectoryFileComparator() {
+ // empty
+ }
+
/**
* Compares the two files using the {@link File#isDirectory()} method.
*
diff --git
a/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java
b/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java
index 26f1bc6e6..2c8ec8f95 100644
---
a/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java
+++
b/src/main/java/org/apache/commons/io/comparator/LastModifiedFileComparator.java
@@ -62,6 +62,13 @@ public class LastModifiedFileComparator extends
AbstractFileComparator implement
/** Reverse last modified comparator instance. */
public static final Comparator<File> LASTMODIFIED_REVERSE = new
ReverseFileComparator(LASTMODIFIED_COMPARATOR);
+ /**
+ * Construct a new instance.
+ */
+ public LastModifiedFileComparator() {
+ // empty
+ }
+
/**
* Compares the last modified date/time of two files.
*
diff --git a/src/main/java/org/apache/commons/io/input/ClosedInputStream.java
b/src/main/java/org/apache/commons/io/input/ClosedInputStream.java
index 561965fdb..d46e61b72 100644
--- a/src/main/java/org/apache/commons/io/input/ClosedInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ClosedInputStream.java
@@ -59,6 +59,13 @@ public class ClosedInputStream extends InputStream {
return in != null ? in : INSTANCE;
}
+ /**
+ * Construct a new instance.
+ */
+ public ClosedInputStream() {
+ // empty
+ }
+
/**
* Returns -1 to indicate that the stream is closed.
*
diff --git a/src/main/java/org/apache/commons/io/input/ClosedReader.java
b/src/main/java/org/apache/commons/io/input/ClosedReader.java
index 71e21d226..af248f677 100644
--- a/src/main/java/org/apache/commons/io/input/ClosedReader.java
+++ b/src/main/java/org/apache/commons/io/input/ClosedReader.java
@@ -49,6 +49,13 @@ public class ClosedReader extends Reader {
@Deprecated
public static final ClosedReader CLOSED_READER = INSTANCE;
+ /**
+ * Construct a new instance.
+ */
+ public ClosedReader() {
+ // empty
+ }
+
@Override
public void close() throws IOException {
// noop
diff --git a/src/main/java/org/apache/commons/io/input/DemuxInputStream.java
b/src/main/java/org/apache/commons/io/input/DemuxInputStream.java
index 0dfdce4ad..fbbf348d6 100644
--- a/src/main/java/org/apache/commons/io/input/DemuxInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/DemuxInputStream.java
@@ -30,6 +30,13 @@ public class DemuxInputStream extends InputStream {
private final InheritableThreadLocal<InputStream> inputStreamLocal = new
InheritableThreadLocal<>();
+ /**
+ * Construct a new instance.
+ */
+ public DemuxInputStream() {
+ // empty
+ }
+
/**
* Binds the specified stream to the current thread.
*
diff --git
a/src/main/java/org/apache/commons/io/input/ObservableInputStream.java
b/src/main/java/org/apache/commons/io/input/ObservableInputStream.java
index 14f39f21e..78a775a5c 100644
--- a/src/main/java/org/apache/commons/io/input/ObservableInputStream.java
+++ b/src/main/java/org/apache/commons/io/input/ObservableInputStream.java
@@ -53,6 +53,13 @@ public class ObservableInputStream extends ProxyInputStream {
private List<Observer> observers;
+ /**
+ * Constructs a new instance for subclasses.
+ */
+ public AbstractBuilder() {
+ // empty
+ }
+
/**
* Sets the list of observer callbacks.
*
@@ -91,6 +98,13 @@ public class ObservableInputStream extends ProxyInputStream {
*/
public static abstract class Observer {
+ /**
+ * Constructs a new instance for subclasses.
+ */
+ public Observer() {
+ // empty
+ }
+
/**
* Called to indicate that the {@link ObservableInputStream} has been
closed.
*
diff --git
a/src/main/java/org/apache/commons/io/monitor/FileAlterationListenerAdaptor.java
b/src/main/java/org/apache/commons/io/monitor/FileAlterationListenerAdaptor.java
index 1204b44fb..69b238cc4 100644
---
a/src/main/java/org/apache/commons/io/monitor/FileAlterationListenerAdaptor.java
+++
b/src/main/java/org/apache/commons/io/monitor/FileAlterationListenerAdaptor.java
@@ -26,6 +26,13 @@ import java.io.File;
*/
public class FileAlterationListenerAdaptor implements FileAlterationListener {
+ /**
+ * Construct a new instance.
+ */
+ public FileAlterationListenerAdaptor() {
+ // empty
+ }
+
/**
* Directory changed Event.
*
diff --git a/src/main/java/org/apache/commons/io/output/ClosedOutputStream.java
b/src/main/java/org/apache/commons/io/output/ClosedOutputStream.java
index 4d1d38a6f..65af2c776 100644
--- a/src/main/java/org/apache/commons/io/output/ClosedOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/ClosedOutputStream.java
@@ -45,6 +45,13 @@ public class ClosedOutputStream extends OutputStream {
@Deprecated
public static final ClosedOutputStream CLOSED_OUTPUT_STREAM = INSTANCE;
+ /**
+ * Construct a new instance.
+ */
+ public ClosedOutputStream() {
+ // empty
+ }
+
/**
* Throws an {@link IOException} to indicate that the stream is closed.
*
diff --git a/src/main/java/org/apache/commons/io/output/ClosedWriter.java
b/src/main/java/org/apache/commons/io/output/ClosedWriter.java
index 7220ba151..307622ac3 100644
--- a/src/main/java/org/apache/commons/io/output/ClosedWriter.java
+++ b/src/main/java/org/apache/commons/io/output/ClosedWriter.java
@@ -45,6 +45,13 @@ public class ClosedWriter extends Writer {
@Deprecated
public static final ClosedWriter CLOSED_WRITER = INSTANCE;
+ /**
+ * Construct a new instance.
+ */
+ public ClosedWriter() {
+ // empty
+ }
+
@Override
public void close() throws IOException {
// noop
diff --git a/src/main/java/org/apache/commons/io/output/DemuxOutputStream.java
b/src/main/java/org/apache/commons/io/output/DemuxOutputStream.java
index bd5070b58..1e3558068 100644
--- a/src/main/java/org/apache/commons/io/output/DemuxOutputStream.java
+++ b/src/main/java/org/apache/commons/io/output/DemuxOutputStream.java
@@ -25,8 +25,16 @@ import org.apache.commons.io.IOUtils;
* Forwards data to a stream that has been associated with this thread.
*/
public class DemuxOutputStream extends OutputStream {
+
private final InheritableThreadLocal<OutputStream> outputStreamThreadLocal
= new InheritableThreadLocal<>();
+ /**
+ * Construct a new instance.
+ */
+ public DemuxOutputStream() {
+ // empty
+ }
+
/**
* Binds the specified stream to the current thread.
*
