Modifier and Type	Class and Description
private class	FileCleaningTracker.Reaper The reaper thread.
private static class	FileCleaningTracker.Tracker Inner class which acts as the reference for a file pending deletion.

Modifier and Type	Field and Description
pack-priv volatile boolean	exitWhenFinished Whether to terminate the thread when the tracking is complete.
pack-priv ReferenceQueue<T>	q Queue of `Tracker` instances being watched.
pack-priv Thread	reaper The thread that will clean up registered files.
pack-priv final Collection<E>	trackers Collection of `Tracker` instances in existence.

Access	Constructor and Description
public	FileCleaningTracker()

Method Summary

Modifier and Type	Method and Description
private synchronized void	addTracker(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) Adds a tracker to the list of trackers.
public 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 int	Returns: the number of files being tracked getTrackCount() Retrieve the number of files currently being tracked, and therefore awaiting deletion.
public void	track(File the file to be tracked, not null file, Object the marker object used to track the file, not null marker) Track the specified file, using the provided marker, deleting the file when the marker instance is garbage collected.
public 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 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) Track the specified file, using the provided marker, deleting the file when the marker instance is garbage collected.
public 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.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

exitWhenFinished	back to summary
pack-priv volatile boolean exitWhenFinished Whether to terminate the thread when the tracking is complete.

q	back to summary
pack-priv ReferenceQueue<T> q Queue of `Tracker` instances being watched.

reaper	back to summary
pack-priv Thread reaper The thread that will clean up registered files.

trackers	back to summary
pack-priv final Collection<E> trackers Collection of `Tracker` instances in existence.

Constructor Detail

FileCleaningTracker	back to summary
public FileCleaningTracker()

Method Detail

addTracker	back to summary
private synchronized void addTracker(String path, Object marker, FileDeleteStrategy deleteStrategy) Adds a tracker to the list of trackers. Parameters path:String the full path to the file to be tracked, not null marker:Object the marker object used to track the file, not null deleteStrategy:FileDeleteStrategy the strategy to delete the file, null means normal

addTracker

back to summary

private synchronized void addTracker(String path, Object marker, FileDeleteStrategy deleteStrategy)

Adds a tracker to the list of trackers.

Parameters

path:String: the full path to the file to be tracked, not null
marker:Object: the marker object used to track the file, not null
deleteStrategy:FileDeleteStrategy: the strategy to delete the file, null means normal

exitWhenFinished back to summary

exitWhenFinished	back to summary
public 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 `javax.servlet.ServletContextListener#contextDestroyed`. One called, no new objects can be tracked by the file cleaner.

public 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 javax.servlet.ServletContextListener#contextDestroyed. One called, no new objects can be tracked by the file cleaner.

getTrackCount	back to summary
public int getTrackCount() Retrieve the number of files currently being tracked, and therefore awaiting deletion. Returns:int the number of files being tracked

getTrackCount

back to summary

public int getTrackCount()

Retrieve the number of files currently being tracked, and therefore awaiting deletion.

Returns:int: the number of files being tracked

track back to summary

track	back to summary
public 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 `normal` deletion strategy will be used. Parameters file:File the file to be tracked, not null marker:Object the marker object used to track the file, not null Exceptions NullPointerException: if the file is null

public 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 normal deletion strategy will be used.

Parameters

file:File: the file to be tracked, not null
marker:Object: the marker object used to track the file, not null

Exceptions

NullPointerException:: if the file is null

track	back to summary
public 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. Parameters file:File the file to be tracked, not null marker:Object the marker object used to track the file, not null deleteStrategy:FileDeleteStrategy the strategy to delete the file, null means normal Exceptions NullPointerException: if the file is null

track

back to summary

public 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.

Parameters

file:File: the file to be tracked, not null
marker:Object: the marker object used to track the file, not null
deleteStrategy:FileDeleteStrategy: the strategy to delete the file, null means normal

Exceptions

NullPointerException:: if the file is null

track back to summary

track	back to summary
public 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 `normal` deletion strategy will be used. Parameters path:String the full path to the file to be tracked, not null marker:Object the marker object used to track the file, not null Exceptions NullPointerException: if the path is null

public 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 normal deletion strategy will be used.

Parameters

path:String: the full path to the file to be tracked, not null
marker:Object: the marker object used to track the file, not null

Exceptions

NullPointerException:: if the path is null

track	back to summary
public 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. Parameters path:String the full path to the file to be tracked, not null marker:Object the marker object used to track the file, not null deleteStrategy:FileDeleteStrategy the strategy to delete the file, null means normal Exceptions NullPointerException: if the path is null

track

back to summary

public 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.

Parameters

path:String: the full path to the file to be tracked, not null
marker:Object: the marker object used to track the file, not null
deleteStrategy:FileDeleteStrategy: the strategy to delete the file, null means normal

Exceptions

NullPointerException:: if the path is null

org.apache.commons.io back to summary

private final Class FileCleaningTracker.Reaper

Class Inheritance

extends Thread

java.lang.Object
java.lang.Thread
org.apache.commons.io.FileCleaningTracker.Reaper

The reaper thread.

Field Summary

Inherited from java.lang.Thread:: MAX_PRIORITY MIN_PRIORITY NORM_PRIORITY

Constructor Summary

Access	Constructor and Description
pack-priv	Reaper() Construct a new Reaper

Method Summary

Modifier and Type	Method and Description
public void	run() Overrides java.lang.Thread.run. Implements java.lang.Runnable.run. Run the reaper thread that will delete files as their associated marker objects are reclaimed by the garbage collector.

Constructor Detail

Reaper	back to summary
pack-priv Reaper() Construct a new Reaper

Method Detail

run	back to summary
public void run() Overrides java.lang.Thread.run. Implements java.lang.Runnable.run. Run the reaper thread that will delete files as their associated marker objects are reclaimed by the garbage collector.

run

back to summary

public void run()

Overrides java.lang.Thread.run.

Implements java.lang.Runnable.run.

Run the reaper thread that will delete files as their associated marker objects are reclaimed by the garbage collector.

org.apache.commons.io back to summary

private final Class FileCleaningTracker.Tracker

Class Inheritance

extends PhantomReference

java.lang.Object
java.lang.ref.Reference
java.lang.ref.PhantomReference
org.apache.commons.io.FileCleaningTracker.Tracker

Inner class which acts as the reference for a file pending deletion.

Field Summary

Modifier and Type	Field and Description
private final FileDeleteStrategy	deleteStrategy The strategy for deleting files.
private final String	path The full path to the file being tracked.

Constructor Summary

Access	Constructor and Description
pack-priv	Tracker(String the full path to the file to be tracked, not null path, FileDeleteStrategy the strategy to delete the file, null means normal deleteStrategy, Object the marker object used to track the file, not null marker, ReferenceQueue<T> the queue on to which the tracker will be pushed, not null queue) Constructs an instance of this class from the supplied parameters.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if the file was deleted successfully; `false` otherwise. delete() Deletes the file associated with this tracker instance.

Inherited from java.lang.ref.PhantomReference:: get

Field Detail

deleteStrategy	back to summary
private final FileDeleteStrategy deleteStrategy The strategy for deleting files.

path	back to summary
private final String path The full path to the file being tracked.

Constructor Detail

Tracker	back to summary
pack-priv Tracker(String path, FileDeleteStrategy deleteStrategy, Object marker, ReferenceQueue<T> queue) Constructs an instance of this class from the supplied parameters. Parameters path:String the full path to the file to be tracked, not null deleteStrategy:FileDeleteStrategy the strategy to delete the file, null means normal marker:Object the marker object used to track the file, not null queue:ReferenceQueue<T> the queue on to which the tracker will be pushed, not null

Tracker

back to summary

pack-priv Tracker(String path, FileDeleteStrategy deleteStrategy, Object marker, ReferenceQueue<T> queue)

Constructs an instance of this class from the supplied parameters.

Parameters

path:String: the full path to the file to be tracked, not null
deleteStrategy:FileDeleteStrategy: the strategy to delete the file, null means normal
marker:Object: the marker object used to track the file, not null
queue:ReferenceQueue<T>: the queue on to which the tracker will be pushed, not null

Method Detail

delete back to summary

delete	back to summary
public boolean delete() Deletes the file associated with this tracker instance. Returns:boolean `true` if the file was deleted successfully; `false` otherwise.

public boolean delete()

Deletes the file associated with this tracker instance.

Returns:boolean: true if the file was deleted successfully; false otherwise.

public Class FileCleaningTracker

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class FileCleaningTracker.Reaper

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class FileCleaningTracker.Tracker

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail