You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/04/06 15:56:27 UTC
[commons-io] branch master updated (f7e0f2c0 -> bd727465)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-io.git
from f7e0f2c0 Let subclasses detect when reading past the maximum is requested
new cd95305f Javadoc
new bd727465 Javadoc
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../org/apache/commons/io/FileCleaningTracker.java | 19 +++++++++++++------
.../org/apache/commons/io/FileDeleteStrategy.java | 1 +
2 files changed, 14 insertions(+), 6 deletions(-)
[commons-io] 02/02: Javadoc
Posted by gg...@apache.org.
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 bd72746581fec8bf4218bf7c4bf91c5311b2482c
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Thu Apr 6 11:54:11 2023 -0400
Javadoc
---
src/main/java/org/apache/commons/io/FileDeleteStrategy.java | 1 +
1 file changed, 1 insertion(+)
diff --git a/src/main/java/org/apache/commons/io/FileDeleteStrategy.java b/src/main/java/org/apache/commons/io/FileDeleteStrategy.java
index 6bc51076..5e6bfc07 100644
--- a/src/main/java/org/apache/commons/io/FileDeleteStrategy.java
+++ b/src/main/java/org/apache/commons/io/FileDeleteStrategy.java
@@ -38,6 +38,7 @@ public class FileDeleteStrategy {
* Force file deletion strategy.
*/
static class ForceFileDeleteStrategy extends FileDeleteStrategy {
+
/** Default Constructor */
ForceFileDeleteStrategy() {
super("Force");
[commons-io] 01/02: Javadoc
Posted by gg...@apache.org.
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 cd95305f2bc0c4d5c58dd8bfd68474ccbe7a0ea6
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Thu Apr 6 11:52:31 2023 -0400
Javadoc
---
.../org/apache/commons/io/FileCleaningTracker.java | 19 +++++++++++++------
1 file changed, 13 insertions(+), 6 deletions(-)
diff --git a/src/main/java/org/apache/commons/io/FileCleaningTracker.java b/src/main/java/org/apache/commons/io/FileCleaningTracker.java
index 0980bed0..5d7ad0ed 100644
--- a/src/main/java/org/apache/commons/io/FileCleaningTracker.java
+++ b/src/main/java/org/apache/commons/io/FileCleaningTracker.java
@@ -33,12 +33,14 @@ import java.util.Objects;
* This utility creates a background thread to handle file deletion.
* Each file to be deleted is registered with a handler object.
* When the handler object is garbage collected, the file is deleted.
+ * </p>
* <p>
* In an environment with multiple class loaders (a servlet container, for
* example), you should consider stopping the background thread if it is no
* longer needed. This is done by invoking the method
* {@link #exitWhenFinished}, typically in
* {@code javax.servlet.ServletContextListener.contextDestroyed(javax.servlet.ServletContextEvent)} or similar.
+ * </p>
*/
public class FileCleaningTracker {
@@ -56,7 +58,7 @@ public class FileCleaningTracker {
}
/**
- * Run the reaper thread that will delete files as their associated
+ * Runs the reaper thread that will delete files as their associated
* marker objects are reclaimed by the garbage collector.
*/
@Override
@@ -77,6 +79,7 @@ public class FileCleaningTracker {
}
}
}
+
/**
* Inner class which acts as the reference for a file pending deletion.
*/
@@ -86,6 +89,7 @@ public class FileCleaningTracker {
* The full path to the file being tracked.
*/
private final String path;
+
/**
* The strategy for deleting files.
*/
@@ -125,14 +129,17 @@ public class FileCleaningTracker {
return path;
}
}
+
/**
* Queue of {@link Tracker} instances being watched.
*/
ReferenceQueue<Object> q = new ReferenceQueue<>();
+
/**
* Collection of {@link Tracker} instances in existence.
*/
final Collection<Tracker> trackers = Collections.synchronizedSet(new HashSet<>()); // synchronized
+
/**
* Collection of File paths that failed to delete.
*/
@@ -201,7 +208,7 @@ public class FileCleaningTracker {
}
/**
- * Return the file paths that failed to delete.
+ * Gets the file paths that failed to delete.
*
* @return the file paths that failed to delete
* @since 2.0
@@ -211,7 +218,7 @@ public class FileCleaningTracker {
}
/**
- * Retrieve the number of files currently being tracked, and therefore
+ * Gets the number of files currently being tracked, and therefore
* awaiting deletion.
*
* @return the number of files being tracked
@@ -234,7 +241,7 @@ public class FileCleaningTracker {
}
/**
- * Track the specified file, using the provided marker, deleting the file
+ * Tracks the specified file, using the provided marker, deleting the file
* when the marker instance is garbage collected.
* The specified deletion strategy is used.
*
@@ -249,7 +256,7 @@ public class FileCleaningTracker {
}
/**
- * Track the specified file, using the provided marker, deleting the file
+ * Tracks the specified file, using the provided marker, deleting the file
* when the marker instance is garbage collected.
* The {@link FileDeleteStrategy#NORMAL normal} deletion strategy will be used.
*
@@ -262,7 +269,7 @@ public class FileCleaningTracker {
}
/**
- * Track the specified file, using the provided marker, deleting the file
+ * Tracks the specified file, using the provided marker, deleting the file
* when the marker instance is garbage collected.
* The specified deletion strategy is used.
*