Package adams.flow.control

Class Breakpoint

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, BooleanConditionSupporter, Actor, ControlActor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class Breakpoint
extends AbstractTransformer
implements ControlActor, BooleanConditionSupporter
    Allows to pause the execution of the flow when this actor is reached and the condition evaluates to 'true'. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: Breakpoint
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
    min-user-mode: Expert
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
    min-user-mode: Expert
 
    -scope-restriction <adams.flow.execution.debug.AbstractScopeRestriction> (property: scopeRestriction)
    The scopeRestriction to use for suspending the flow execution.
    default: adams.flow.execution.debug.NoScopeRestriction
 
    -on-pre-input <boolean> (property: onPreInput)
    If set to true, the breakpoint gets evaluated at pre-input (of token) time;
     token available.
    default: false
 
    -on-post-input <boolean> (property: onPostInput)
    If set to true, the breakpoint gets evaluated at post-input (of token) time.
    default: false
 
    -on-pre-execute <boolean> (property: onPreExecute)
    If set to true, the breakpoint gets evaluated at pre-execute time.
    default: true
 
    -on-post-execute <boolean> (property: onPostExecute)
    If set to true, the breakpoint gets evaluated at post-execute time.
    default: false
 
    -on-pre-output <boolean> (property: onPreOutput)
    If set to true, the breakpoint gets evaluated at pre-output (of token) time;
     token available.
    default: false
 
    -on-post-output <boolean> (property: onPostOutput)
    If set to true, the breakpoint gets evaluated at post-output (of token)
    time.
    default: false
 
    -condition <adams.flow.condition.bool.BooleanCondition> (property: condition)
    The condition to evaluate; if the condition evaluates to 'true', the execution
    of the flow is paused.
    default: adams.flow.condition.bool.Expression
 
    -watch <adams.core.base.BaseString> [-watch ...] (property: watches)
    The expression to display initially in the watch dialog; the type of the
    watch needs to be specified as well.
    default:
 
    -watch-type <VARIABLE|STRING|BOOLEAN_EXPRESSION|MATH_EXPRESSION|STRING_EXPRESSION> [-watch-type ...] (property: watchTypes)
    The types of the watch expressions; determines how the expressions get evaluated
    and displayed.
    default:
 
    -view <SOURCE|EXPRESSIONS|VARIABLES|STORAGE|INSPECT_TOKEN|BREAKPOINTS> [-view ...] (property: views)
    The views to display automatically when the breakpoint is reached.
    default:
 
    -bring-to-front <boolean> (property: bringToFront)
    If set to true, it is attempted to bring the flow editor window to the front
    once the breakpoint is reached. NB Does not work on all platforms.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_OnPreInput

        protected boolean m_OnPreInput
        break on preInput.

      • m_OnPostInput

        protected boolean m_OnPostInput
        break on postInput.

      • m_OnPreExecute

        protected boolean m_OnPreExecute
        break on preExecute.

      • m_OnPostExecute

        protected boolean m_OnPostExecute
        break on postExecute.

      • m_OnPreOutput

        protected boolean m_OnPreOutput
        break on preOutput.

      • m_OnPostOutput

        protected boolean m_OnPostOutput
        break on postOutput.

      • m_Condition

        protected BooleanCondition m_Condition
        the condition to evaluate.

      • m_Views

        protected View[] m_Views
        the views to display automatically.

      • m_Watches

        protected BaseString[] m_Watches
        the watch expressions.

      • m_BringToFront

        protected boolean m_BringToFront
        whether to bring the window to the front.

    • Constructor Detail

      • Breakpoint

        public Breakpoint()

    • Method Detail

      • setScopeRestriction

        public void setScopeRestriction​(AbstractScopeRestriction value)
        Sets the restriction for the scope to use for suspending the flow execution.
        Parameters:
        value - the restriction

      • getScopeRestriction

        public AbstractScopeRestriction getScopeRestriction()
        Returns the restriction for the scope to use for suspending the flow execution.
        Returns:
        the restriction

      • scopeRestrictionTipText

        public String scopeRestrictionTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setOnPreInput

        public void setOnPreInput​(boolean value)
        Sets whether to evaluate the breakpoing on pre-input (of token).
        Parameters:
        value - true if evaluated

      • getOnPreInput

        public boolean getOnPreInput()
        Returns whether the breakpoint gets evaluated on pre-input (of token).
        Returns:
        true if evaluated

      • onPreInputTipText

        public String onPreInputTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setOnPostInput

        public void setOnPostInput​(boolean value)
        Sets whether to evaluate the breakpoing on post-input (of token).
        Parameters:
        value - true if evaluated

      • getOnPostInput

        public boolean getOnPostInput()
        Returns whether the breakpoint gets evaluated on post-input (of token).
        Returns:
        true if evaluated

      • onPostInputTipText

        public String onPostInputTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setOnPreExecute

        public void setOnPreExecute​(boolean value)
        Sets whether to evaluate the breakpoing on pre-execute.
        Parameters:
        value - true if evaluated

      • getOnPreExecute

        public boolean getOnPreExecute()
        Returns whether the breakpoint gets evaluated on pre-execute.
        Returns:
        true if evaluated

      • onPreExecuteTipText

        public String onPreExecuteTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setOnPostExecute

        public void setOnPostExecute​(boolean value)
        Sets whether to evaluate the breakpoing on post-execute.
        Parameters:
        value - true if evaluated

      • getOnPostExecute

        public boolean getOnPostExecute()
        Returns whether the breakpoint gets evaluated on post-execute.
        Returns:
        true if evaluated

      • onPostExecuteTipText

        public String onPostExecuteTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setOnPreOutput

        public void setOnPreOutput​(boolean value)
        Sets whether to evaluate the breakpoing on pre-output (of token).
        Parameters:
        value - true if evaluated

      • getOnPreOutput

        public boolean getOnPreOutput()
        Returns whether the breakpoint gets evaluated on pre-output (of token).
        Returns:
        true if evaluated

      • onPreOutputTipText

        public String onPreOutputTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setOnPostOutput

        public void setOnPostOutput​(boolean value)
        Sets whether to evaluate the breakpoing on post-output (of token).
        Parameters:
        value - true if evaluated

      • getOnPostOutput

        public boolean getOnPostOutput()
        Returns whether the breakpoint gets evaluated on post-output (of token).
        Returns:
        true if evaluated

      • onPostOutputTipText

        public String onPostOutputTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • conditionTipText

        public String conditionTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setWatches

        public void setWatches​(BaseString[] value)
        Sets the watch expressions for the watch dialog.
        Parameters:
        value - the expressions

      • getWatches

        public BaseString[] getWatches()
        Returns the watch expressions for the watch dialog.
        Returns:
        the expressions

      • watchesTipText

        public String watchesTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • watchTypesTipText

        public String watchTypesTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setViews

        public void setViews​(View[] value)
        Sets the views to display automatically.
        Parameters:
        value - the views

      • getViews

        public View[] getViews()
        Returns the views to display automatically.
        Returns:
        the views

      • viewsTipText

        public String viewsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setBringToFront

        public void setBringToFront​(boolean value)
        Sets whether to bring the flow editor window to the front once the breakpoint is reached.
        Parameters:
        value - true if to bring to front

      • getBringToFront

        public boolean getBringToFront()
        Returns whether to bring the flow editor window to the front once the breakpoint is reached.
        Returns:
        true if to bring to front

      • bringToFrontTipText

        public String bringToFrontTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        adams.flow.core.Unknown.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        adams.flow.core.Unknown.class

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message