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.
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
exitWhenFinished, typically in
javax. or similar.
| Modifier and Type | Field and Description |
|---|---|
| pack-priv static final FileCleaningTracker | theInstance
The instance to use for the deprecated, static methods. |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public static synchronized void | exitWhenFinished()
Call this method to cause the file cleaner thread to terminate when there are no more objects being tracked for deletion. |
| public static FileCleaningTracker | |
| public static int | Returns: the number of files being trackedRetrieve the number of files currently being tracked, and therefore awaiting deletion. |
| public static void | |
| public static void | track(File
the file to be tracked, not null file, Object the marker object used to track the file, not null marker, FileDeleteStrategy the strategy to delete the file, null means normal deleteStrategy)Track the specified file, using the provided marker, deleting the file when the marker instance is garbage collected. |
| public static void | |
| public static void | track(String
the full path to the file to be tracked, not null path, Object the marker object used to track the file, not null marker, FileDeleteStrategy the strategy to delete the file, null means normal deleteStrategy)Track the specified file, using the provided marker, deleting the file when the marker instance is garbage collected. |
| theInstance | back to summary |
|---|---|
| pack-priv static final FileCleaningTracker theInstance The instance to use for the deprecated, static methods. | |
| FileCleaner | back to summary |
|---|---|
| public FileCleaner() | |
| exitWhenFinished | back to summary |
|---|---|
| public static synchronized void exitWhenFinished() Call this method to cause the file cleaner thread to terminate when there are no more objects being tracked for deletion. In a simple environment, you don't need this method as the file cleaner thread will simply exit when the JVM exits. In a more complex environment, with multiple class loaders (such as an application server), you should be aware that the file cleaner thread will continue running even if the class loader it was started from terminates. This can consitute a memory leak. For example, suppose that you have developed a web application, which contains the commons-io jar file in your WEB-INF/lib directory. In other words, the FileCleaner class is loaded through the class loader of your web application. If the web application is terminated, but the servlet container is still running, then the file cleaner thread will still exist, posing a memory leak.
This method allows the thread to be terminated. Simply call this method
in the resource cleanup code, such as | |
| getInstance | back to summary |
|---|---|
| public static FileCleaningTracker getInstance() Returns the singleton instance, which is used by the deprecated, static methods.
This is mainly useful for code, which wants to support the new
| |
| getTrackCount | back to summary |
|---|---|
| public static int getTrackCount() Retrieve the number of files currently being tracked, and therefore awaiting deletion.
| |
| track | back to summary |
|---|---|
| public static void track(File file, Object marker) Track the specified file, using the provided marker, deleting the file
when the marker instance is garbage collected.
The
| |
| track | back to summary |
|---|---|
| public static void track(File file, Object marker, FileDeleteStrategy deleteStrategy) Track the specified file, using the provided marker, deleting the file when the marker instance is garbage collected. The speified deletion strategy is used.
| |
| track | back to summary |
|---|---|
| public static void track(String path, Object marker) Track the specified file, using the provided marker, deleting the file
when the marker instance is garbage collected.
The
| |
| track | back to summary |
|---|---|
| public static void track(String path, Object marker, FileDeleteStrategy deleteStrategy) Track the specified file, using the provided marker, deleting the file when the marker instance is garbage collected. The speified deletion strategy is used.
| |