Package adams.flow.control

Interface AtomicExecution

All Superinterfaces:

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

All Known Implementing Classes:

AbstractConnectedControlActor, AbstractContainerUpdater, AbstractDataContainerFileChecker, AbstractDirectedControlActor, AbstractTee, ArrayGenerate, ArrayProcess, AutogeneratedSink, AutogeneratedSource, AutogeneratedStandalone, AutogeneratedTransformer, Branch, CallableActors, CollectionProcess, ConditionalSequence, ConditionalStandalones, ConditionalSubProcess, ConditionalTee, ConditionalTrigger, ContainerValuePicker, Count, Flow, IfStorageValue, IfThenElse, InactiveSink, InactiveSource, InactiveStandalone, InactiveTransformer, InputOutputListener, JMap, LocalScopeSubProcess, LocalScopeTee, LocalScopeTransformer, LocalScopeTrigger, MutableConnectedControlActor, MutableControlActor, Once, PlotContainerUpdater, Rejector, RemoteExecutionTrigger, Sequence, SequenceSource, SinkReset, SourceReset, Standalones, StorageValueSequence, SubProcess, Switch, Tee, TimedSubProcess, TimedTee, TimedTrigger, TransformerReset, Trigger, TriggerOnce, UpdateContainerValue

public interface AtomicExecution
extends Actor

Interface for actors that can be configured to finish execution first before attempting to be stopped. Useful for encapsulating critical steps.

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
String	finishBeforeStoppingTipText()	Returns the tip text for this property.
boolean	getFinishBeforeStopping()	Returns whether to finish processing before stopping execution.
int	getStoppingTimeout()	Returns the timeout for waiting for the sub-flow to stop.
void	setFinishBeforeStopping(boolean value)	Sets whether to finish processing before stopping execution.
void	setStoppingTimeout(int value)	Sets the timeout for waiting for the sub-flow to stop.
String	stoppingTimeoutTipText()	Returns the tip text for this property.

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

setFinishBeforeStopping

void setFinishBeforeStopping(boolean value)

Sets whether to finish processing before stopping execution.

Parameters:

value - if true then actor finishes processing first

getFinishBeforeStopping

boolean getFinishBeforeStopping()

Returns whether to finish processing before stopping execution.

Returns:

true if actor finishes processing first

finishBeforeStoppingTipText

String finishBeforeStoppingTipText()

Returns the tip text for this property.

Returns:

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

setStoppingTimeout

void setStoppingTimeout(int value)

Sets the timeout for waiting for the sub-flow to stop.

Parameters:

value - timeout in milliseconds (<= 0 for infinity)

getStoppingTimeout

int getStoppingTimeout()

Returns the timeout for waiting for the sub-flow to stop.

Returns:

timeout in milliseconds (<= 0 for infinity)

stoppingTimeoutTipText

String stoppingTimeoutTipText()

Returns the tip text for this property.

Returns:

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