Package adams.flow.core

Interface LazySetupSupporter

All Superinterfaces:

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

public interface LazySetupSupporter
extends Actor

Interface for actors that optionally perform a Actor.setUp() call first time they get executed.

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
boolean	getPerformLazySetup()	Returns whether to perform a lazy setup, ie when first executed.
boolean	hasLazySetupPerformed()	Returns whether lazy setup has been performed.
String	lazySetup()	Performs the lazy setup.
String	performLazySetupTipText()	Returns the tip text for this property.
void	setPerformLazySetup(boolean value)	Sets whether to perform a lazy setup, ie when first executed.

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

setPerformLazySetup

void setPerformLazySetup(boolean value)

Sets whether to perform a lazy setup, ie when first executed.

Parameters:

value - true if to perform lazy setup

getPerformLazySetup

boolean getPerformLazySetup()

Returns whether to perform a lazy setup, ie when first executed.

Returns:

true if to perform lazy setup

performLazySetupTipText

String performLazySetupTipText()

Returns the tip text for this property.

Returns:

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

hasLazySetupPerformed

boolean hasLazySetupPerformed()

Returns whether lazy setup has been performed.

Returns:

true if performed

lazySetup

String lazySetup()

Performs the lazy setup.

Returns:

null if successful, otherwise error message