com.nt.udc.util

Class FileSystemCleaner

java.lang.Object

com.nt.udc.util.FileSystemCleaner

All Implemented Interfaces:

java.awt.event.ActionListener, java.util.EventListener

public class FileSystemCleaner
extends java.lang.Object
implements java.awt.event.ActionListener

This class handles file system cleaning, and has the option to make it timer based. The main idea is to use this is a routine where a directory becomes "expired", and is no longer used. When a directory is no longer in use, add it to the cleaner, and the timer will eventually delete it. Also, one may explicitly call "clean()" to delete any directories that the clean currently knows about.

Constructor Summary

Constructors

Constructor and Description
FileSystemCleaner(LoggerIfc logger) Constructs a FileSystemCleaner with a logger.
FileSystemCleaner(LoggerIfc logger, int cleanerDelay) Constructs a FileSystemCleaner with a logger and timer delay.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent ae) Event handler for timer.
void	addDir(java.io.File dir) Adds a directory to delete.
void	addDirs(java.io.File[] dirs) Adds some directories to delete.
void	clean() Cleans the known directories and files.
void	startCleaning() Starts the timer.
void	startCleaning(int delay) Starts cleaning with a given delay.
void	stopCleaning() Stops the cleaning timer.
java.lang.String	toString() Converts directory info to a String.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemCleaner

public FileSystemCleaner(LoggerIfc logger)

Constructs a FileSystemCleaner with a logger.

Parameters:

logger - Logger for errors and warnings.

FileSystemCleaner

public FileSystemCleaner(LoggerIfc logger,
                         int cleanerDelay)

Constructs a FileSystemCleaner with a logger and timer delay.

Parameters:

logger - Logger for errors and warnings.

cleanerDelay - Delay for timer.

Method Detail

addDir

public void addDir(java.io.File dir)

Adds a directory to delete.

Parameters:

dir - Directory to delete.

addDirs

public void addDirs(java.io.File[] dirs)

Adds some directories to delete.

Parameters:

dirs - Directories to delete.

clean

public void clean()
           throws java.io.IOException

Cleans the known directories and files.

Throws:

java.io.IOException

startCleaning

public void startCleaning()

Starts the timer.

startCleaning

public void startCleaning(int delay)

Starts cleaning with a given delay.

Parameters:

delay - Timer delay.

stopCleaning

public void stopCleaning()

Stops the cleaning timer.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent ae)

Event handler for timer.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

toString

public java.lang.String toString()

Converts directory info to a String.

Overrides:

toString in class java.lang.Object

Returns:

String representation of FileSystemCleaner