Package adams.flow.core

Interface StopRestrictor

All Superinterfaces:

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

All Known Subinterfaces:

OptionalStopRestrictor

All Known Implementing Classes:

AbstractContainerUpdater, ArrayProcess, AutogeneratedSink, AutogeneratedTransformer, CollectionProcess, ConditionalSequence, ConditionalSubProcess, Flow, InactiveSink, InactiveTransformer, InputOutputListener, LocalScopeSubProcess, LocalScopeTee, LocalScopeTransformer, LocalScopeTrigger, PlotContainerUpdater, Sequence, SinkReset, StorageValueSequence, SubProcess, TimedSubProcess, TransformerReset, UpdateContainerValue

public interface StopRestrictor
extends Actor

Interface for actors that can limit the scope of the Stop control actor or other actors that can stop the execution.

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	isRestrictedStop()	Returns whether the stop was a restricted one (that can be resumed).
boolean	isRestrictingStops()	Returns whether stops are being restricted.
void	restrictedStopExecution()	Stops the (restricted) execution.
void	restrictedStopExecution(String msg)	Stops the (restricted) execution.

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

isRestrictingStops

boolean isRestrictingStops()

Returns whether stops are being restricted.

Returns:

true if restricting stops

restrictedStopExecution

void restrictedStopExecution()

Stops the (restricted) execution. No message set.

restrictedStopExecution

void restrictedStopExecution(String msg)

Stops the (restricted) execution.

Parameters:

msg - the message to set as reason for stopping, can be null

isRestrictedStop

boolean isRestrictedStop()

Returns whether the stop was a restricted one (that can be resumed).

Returns:

true if restricted stop occurred