Package backupmanager.action

Class BackupAction

java.lang.Object

backupmanager.action.BackupAction

All Implemented Interfaces:

BackupFunction

Direct Known Subclasses:

CopyFile, DeleteFile

public abstract class BackupAction
extends Object
implements BackupFunction

Constructor Summary

Constructors

Constructor	Description
BackupAction(ActionMaker actionMaker, BackupStream backupStream)

Method Summary

Modifier and Type	Method	Description
abstract boolean	doAction(BackupManager backupManager, BackupStream backupStream, StreamItem streamItem)	Perform a backup action.
ActionMaker	getActionMaker()
BackupFilter	getBackupFilter()
BackupStream	getBackupStream()
abstract PamDialogPanel	getDialogPanel(Window owner)	Get a dialog panel for this action to incorporate into a larger dialog.
abstract String	getName()
abstract ActionSettings	getSettings()	Get settings associated with this action.
String	getSpace()
abstract boolean	runIfPreviousActionError()	flag to say whether or not to run this action if any previous action threw an error.
void	setBackupFilter(BackupFilter backupFilter)
abstract boolean	setSettings(ActionSettings settings)	Set settings.
boolean	showDialog(Window owner)

Methods inherited from class java.lang.Object

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

Constructor Details

BackupAction

public BackupAction(ActionMaker actionMaker,
 BackupStream backupStream)

Method Details

doAction

public abstract boolean doAction(BackupManager backupManager,
 BackupStream backupStream,
 StreamItem streamItem)
                          throws BackupException

Perform a backup action. Return false or throw an exception if the action fails.

Parameters:

backupManager -

streamItem -

streamInformation -

Returns:

Throws:

BackupException

getSettings

public abstract ActionSettings getSettings()

Get settings associated with this action.
All actions must return settings even if they have nothing in them, since the settings are needed to recreate the action based on it's class name.

Returns:

action settings

setSettings

public abstract boolean setSettings(ActionSettings settings)

Set settings. Will return false if they were the wrong type for this action - though that should not be possible.

Parameters:

settings -

Returns:

true if settings are OK.

showDialog

public boolean showDialog(Window owner)

Returns:

a dialog panel for controlling any of the settings.

runIfPreviousActionError

public abstract boolean runIfPreviousActionError()

flag to say whether or not to run this action if any previous action threw an error. Actions such as a file copy would probably want to run anyway, since may be copying to different disks and if one is full, you'd want to copy to the other. But if you'd failed to copy a file to a backup drive, you probably wouldn't want to delete it!

Returns:

true if it's OK to run this action when a previous action failed.

getDialogPanel

public abstract PamDialogPanel getDialogPanel(Window owner)

Get a dialog panel for this action to incorporate into a larger dialog.

Specified by:

getDialogPanel in interface BackupFunction

Parameters:

owner -

Returns:

dialog panel (assuming most actions have one - can return null).

getName

public abstract String getName()

Specified by:

getName in interface BackupFunction

Returns:

a name for the action, to display in dialogs

getBackupStream

public BackupStream getBackupStream()

Returns:

the backupStream

getActionMaker

public ActionMaker getActionMaker()

Returns:

the actionMaker

getBackupFilter

public BackupFilter getBackupFilter()

setBackupFilter

public void setBackupFilter(BackupFilter backupFilter)

getSpace

public String getSpace()