com.mucommander.job
Class DeleteJob

java.lang.Object
  com.mucommander.job.FileJob
      com.mucommander.job.DeleteJob

All Implemented Interfaces:

java.lang.Runnable

public class DeleteJob
extends FileJob

This class is responsible for deleting a set of files. This job can operate in two modes, depending on the boolean value specified in the construtor:

• moveToTrash enabled: files are moved to the trash returned by DesktopManager.getTrash().
• moveToTrash disabled: files are permanently deleted, i.e deleted files cannot be recovered. In this mode, folders are deleted recursively

Author:

Maxence Bernard

Field Summary

Fields inherited from class com.mucommander.job.FileJob

APPEND_ACTION, APPEND_TEXT, baseSourceFolder, CANCEL_ACTION, CANCEL_TEXT, currentFile, currentFileIndex, currentFilename, files, FINISHED, INTERRUPTED, mainFrame, nbFiles, NOT_STARTED, PAUSED, progressDialog, RETRY_ACTION, RETRY_TEXT, RUNNING, SKIP_ACTION, SKIP_TEXT

Constructor Summary

DeleteJob(ProgressDialog progressDialog, MainFrame mainFrame, FileSet files, boolean moveToTrash)
Creates a new DeleteJob without starting it.

Method Summary

java.lang.String	getStatusString() Returns a String describing what the job is currently doing.
protected boolean	hasFolderChanged(AbstractFile folder) Returns true if the given folder has or may have been modified by this job.
protected void	jobCompleted() This method is called when this job has completed normal execution : all files have been processed without any interruption (without any call to FileJob.interrupt()).
protected void	jobStopped() This method is called when this job has been stopped.
protected boolean	processFile(AbstractFile file, java.lang.Object recurseParams) Deletes recursively the given file or folder.

Methods inherited from class com.mucommander.job.FileJob

addFileJobListener, getCurrentFileIndex, getCurrentFilename, getEffectiveJobTime, getEndDate, getNbFiles, getPausedTime, getPauseStartDate, getStartDate, getState, getTotalPercentDone, interrupt, jobPaused, jobResumed, jobStarted, nextFile, refreshTables, removeFileJobListener, run, selectFileWhenFinished, setAutoUnmark, setPaused, setState, showErrorDialog, showErrorDialog, start, waitForUserResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteJob

public DeleteJob(ProgressDialog progressDialog,
                 MainFrame mainFrame,
                 FileSet files,
                 boolean moveToTrash)

Creates a new DeleteJob without starting it.

Parameters:

progressDialog - dialog which shows this job's progress

mainFrame - mainFrame this job has been triggered by

files - files which are going to be deleted

moveToTrash - if true, files will be moved to the trash, if false they will be permanently deleted. Should be true only if a trash is available on the current platform.

Method Detail

processFile

protected boolean processFile(AbstractFile file,
                              java.lang.Object recurseParams)

Deletes recursively the given file or folder.

Specified by:

processFile in class FileJob

Parameters:

file - the file or folder to delete

recurseParams - not used

Returns:

true if the file has been completely deleted.

hasFolderChanged

protected boolean hasFolderChanged(AbstractFile folder)

Description copied from class: FileJob

Returns true if the given folder has or may have been modified by this job. This method is called after this job has finished processing files, to determine if the current MainFrame's file tables need to be refreshed to reveal the modified contents.

Specified by:

hasFolderChanged in class FileJob

Parameters:

folder - the folder to test

Returns:

true if the given folder has or may have been modified by this job

jobStopped

protected void jobStopped()

Description copied from class: FileJob

This method is called when this job has been stopped. The call happens after all calls to FileJob.processFile(AbstractFile,Object) and FileJob.jobCompleted(). This method implementation does nothing but it can be overriden by subclasses to properly terminate the job. This is where you want to close any opened connections.

Note that unlike FileJob.jobCompleted() this method is always called, whether the job has been completed (all files were processed) or has been interrupted in the middle.

Overrides:

jobStopped in class FileJob

jobCompleted

protected void jobCompleted()

Description copied from class: FileJob

This method is called when this job has completed normal execution : all files have been processed without any interruption (without any call to FileJob.interrupt()).

The call happens after the last call to FileJob.processFile(AbstractFile,Object) is made. This method implementation does nothing but it can be overriden by subclasses to properly complete the job.

Note that this method will NOT be called if a call to FileJob.interrupt() was made before all files were processed.

Overrides:

jobCompleted in class FileJob

getStatusString

public java.lang.String getStatusString()

Description copied from class: FileJob

Returns a String describing what the job is currently doing. This default implementation returns Processing CURRENT_FILE where CURRENT_FILE is the name of the file currently being processed. This method should be overridden to provide a more accurate description.

Overrides:

getStatusString in class FileJob

Returns:

a String describing what the job is currently doing