Package adams.flow.core

Interface RestorableActor

All Superinterfaces:

Actor, AdditionalInformationHandler, CleanUpHandler, Comparable, Destroyable, ErrorHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, Serializable, ShallowCopySupporter<Actor>, Stoppable, StoppableWithFeedback, VariableChangeListener, VariablesInspectionHandler

All Known Implementing Classes:

EnterManyValues, EnterValue, SelectDirectory, SelectFile

public interface RestorableActor
extends Actor

Interface for actors that can save their state to disk and restore it again next time they are run.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

Field Summary

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Method Summary

Modifier and Type	Method	Description
PlaceholderFile	getRestorationFile()	Returns the file for storing the state.
boolean	isRestorationEnabled()	Returns whether restoration is enabled.
String	restorationEnabledTipText()	Returns the tip text for this property.
String	restorationFileTipText()	Returns the tip text for this property.
void	setRestorationEnabled(boolean value)	Sets whether to enable restoration.
void	setRestorationFile(PlaceholderFile value)	Sets the file for storing the state.

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getQuickInfo, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Method Detail

setRestorationEnabled

void setRestorationEnabled(boolean value)

Sets whether to enable restoration.

Parameters:

value - true if to enable restoration

isRestorationEnabled

boolean isRestorationEnabled()

Returns whether restoration is enabled.

Returns:

true if restoration enabled

restorationEnabledTipText

String restorationEnabledTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setRestorationFile

void setRestorationFile(PlaceholderFile value)

Sets the file for storing the state.

Parameters:

value - the file

getRestorationFile

PlaceholderFile getRestorationFile()

Returns the file for storing the state.

Returns:

the file

restorationFileTipText

String restorationFileTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.