File	Doc	Category	Size	Date	Package
FileCleaningTracker.java	API Doc	Android 1.5 API	10584	Wed May 06 22:42:46 BST 2009	org.apache.commons.io

FileCleaningTracker

• java.lang.Object

Fields Summary
ReferenceQueue	q Queue of Tracker instances being watched.
final Collection	trackers Collection of Tracker instances in existence.
volatile boolean	exitWhenFinished Whether to terminate the thread when the tracking is complete.
Thread	reaper The thread that will clean up registered files.

Constructors Summary

Methods Summary
private synchronized void	addTracker(java.lang.String path, java.lang.Object marker, org.apache.commons.io.FileDeleteStrategy deleteStrategy) Adds a tracker to the list of trackers. param path the full path to the file to be tracked, not null param marker the marker object used to track the file, not null param deleteStrategy the strategy to delete the file, null means normal // synchronized block protects reaper if (exitWhenFinished) { throw new IllegalStateException("No new trackers can be added once exitWhenFinished() is called"); } if (reaper == null) { reaper = new Reaper(); reaper.start(); } trackers.add(new Tracker(path, deleteStrategy, marker, q));
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 {@link javax.servlet.ServletContextListener#contextDestroyed}. One called, no new objects can be tracked by the file cleaner. // synchronized block protects reaper exitWhenFinished = true; if (reaper != null) { synchronized (reaper) { reaper.interrupt(); } }
public int	getTrackCount() Retrieve the number of files currently being tracked, and therefore awaiting deletion. return the number of files being tracked return trackers.size();
public void	track(java.io.File file, java.lang.Object marker) Track 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. param file the file to be tracked, not null param marker the marker object used to track the file, not null throws NullPointerException if the file is null //----------------------------------------------------------------------- track(file, marker, (FileDeleteStrategy) null);
public void	track(java.io.File file, java.lang.Object marker, org.apache.commons.io.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. param file the file to be tracked, not null param marker the marker object used to track the file, not null param deleteStrategy the strategy to delete the file, null means normal throws NullPointerException if the file is null if (file == null) { throw new NullPointerException("The file must not be null"); } addTracker(file.getPath(), marker, deleteStrategy);
public void	track(java.lang.String path, java.lang.Object marker) Track 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. param path the full path to the file to be tracked, not null param marker the marker object used to track the file, not null throws NullPointerException if the path is null track(path, marker, (FileDeleteStrategy) null);
public void	track(java.lang.String path, java.lang.Object marker, org.apache.commons.io.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. param path the full path to the file to be tracked, not null param marker the marker object used to track the file, not null param deleteStrategy the strategy to delete the file, null means normal throws NullPointerException if the path is null if (path == null) { throw new NullPointerException("The path must not be null"); } addTracker(path, marker, deleteStrategy);