org.apache.commons.io
Class FileCleaner

java.lang.Object
  org.apache.commons.io.FileCleaner

public class FileCleaner

extends Object

Keeps track of files awaiting deletion, and deletes them when an associated marker object is reclaimed by the garbage collector.

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.

Version:

$Id: FileCleaner.java 289999 2005-09-18 23:12:45Z scolebourne $

Constructor Summary

FileCleaner()

Method Summary

static int	getTrackCount() Retrieve the number of files currently being tracked, and therefore awaiting deletion.
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.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileCleaner

public FileCleaner()

Method Detail

track

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.

Parameters:

file - The file to be tracked.

marker - The marker object used to track the file.

track

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.

Parameters:

path - The full path to the file to be tracked.

marker - The marker object used to track the file.

getTrackCount

public static int getTrackCount()

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

Returns:

the number of files being tracked.