Interface IBslLineBreakpoint

  • All Superinterfaces:
    org.eclipse.core.runtime.IAdaptable, org.eclipse.debug.core.model.IBreakpoint, IBslBreakpoint, org.eclipse.debug.core.model.ILineBreakpoint

    public interface IBslLineBreakpoint
    extends IBslBreakpoint, org.eclipse.debug.core.model.ILineBreakpoint
    BSL line breakpoint. This breakpoint suspends execution when a particular line of code is reached.

    Clients may use IBslBreakpointFactory to create instances of BSL breakpoints.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String CONDITION
      Breakpoint attribute storing a breakpoint's conditional expression.
      static String CONDITION_ENABLED
      Breakpoint attribute storing a breakpoint's condition enabled state.
      static String EXPIRED
      Breakpoint attribute storing the expired value.
      static String HIT_COUNT
      Breakpoint attribute storing a breakpoint's hit count value.
      static String MARKER_TYPE
      Marker type for this breakpoint.
      • Fields inherited from interface org.eclipse.debug.core.model.IBreakpoint

        BREAKPOINT_MARKER, ENABLED, ID, LINE_BREAKPOINT_MARKER, PERSISTED, REGISTERED
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getCondition()
      Returns the conditional expression associated with this breakpoint, or null if this breakpoint doe not have a condition.
      int getHitCount()
      Returns this breakpoint's hit count or, -1 if this breakpoint does not have a hit count.
      boolean isConditionEnabled()
      Returns whether the condition on this breakpoint is enabled.
      boolean isExpired()
      Returns whether this breakpoint has expired.
      void setCondition​(String condition)
      Sets the condition associated with this breakpoint.
      void setConditionEnabled​(boolean enabled)
      Sets the enabled state of this breakpoint's condition to the given state.
      void setExpired​(boolean expired)
      Sets whether this breakpoint's hit count has expired.
      void setHitCount​(int count)
      Sets the hit count attribute of this breakpoint.
      • Methods inherited from interface org.eclipse.core.runtime.IAdaptable

        getAdapter
      • Methods inherited from interface org.eclipse.debug.core.model.IBreakpoint

        delete, getMarker, getModelIdentifier, isEnabled, isPersisted, isRegistered, setEnabled, setMarker, setPersisted, setRegistered
      • Methods inherited from interface org.eclipse.debug.core.model.ILineBreakpoint

        getCharEnd, getCharStart, getLineNumber
    • Field Detail

      • CONDITION

        static final String CONDITION
        Breakpoint attribute storing a breakpoint's conditional expression. This attribute is stored as a String.
        See Also:
        Constant Field Values
      • CONDITION_ENABLED

        static final String CONDITION_ENABLED
        Breakpoint attribute storing a breakpoint's condition enabled state. This attribute is stored as an boolean.
        See Also:
        Constant Field Values
      • HIT_COUNT

        static final String HIT_COUNT
        Breakpoint attribute storing a breakpoint's hit count value. This attribute is stored as an int.
        See Also:
        Constant Field Values
      • EXPIRED

        static final String EXPIRED
        Breakpoint attribute storing the expired value. Once a hit count has been reached, a breakpoint is considered to be "expired". This attribute is stored as a boolean.
        See Also:
        Constant Field Values
    • Method Detail

      • getCondition

        String getCondition()
                     throws org.eclipse.core.runtime.CoreException
        Returns the conditional expression associated with this breakpoint, or null if this breakpoint doe not have a condition.
        Returns:
        this breakpoint's conditional expression, or null
        Throws:
        org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker
      • setCondition

        void setCondition​(String condition)
                   throws org.eclipse.core.runtime.CoreException
        Sets the condition associated with this breakpoint. When the condition is enabled, this breakpoint will only suspend execution when the given condition evaluates to true. Setting the condition to null or an empty string removes the condition.

        If this breakpoint does not support conditions, setting the condition has no effect.

        Parameters:
        condition - conditional expression, can be null, then condition will be removed
        Throws:
        org.eclipse.core.runtime.CoreException - if unable to set the property on this breakpoint's underlying marker
      • isConditionEnabled

        boolean isConditionEnabled()
                            throws org.eclipse.core.runtime.CoreException
        Returns whether the condition on this breakpoint is enabled.
        Returns:
        whether this breakpoint's condition is enabled
        Throws:
        org.eclipse.core.runtime.CoreException - if unable to access the property on this breakpoint's underlying marker
      • setConditionEnabled

        void setConditionEnabled​(boolean enabled)
                          throws org.eclipse.core.runtime.CoreException
        Sets the enabled state of this breakpoint's condition to the given state. When enabled, this breakpoint will only suspend when its condition evaluates to true. When disabled, this breakpoint will suspend as it would with no condition defined.
        Parameters:
        enabled - the enabled state of the condition
        Throws:
        org.eclipse.core.runtime.CoreException - if unable to set the property on this breakpoint's underlying marker
      • getHitCount

        int getHitCount()
                 throws org.eclipse.core.runtime.CoreException
        Returns this breakpoint's hit count or, -1 if this breakpoint does not have a hit count.
        Returns:
        this breakpoint's hit count, or -1
        Throws:
        org.eclipse.core.runtime.CoreException - if unable to access the property from this breakpoint's underlying marker
      • setHitCount

        void setHitCount​(int count)
                  throws org.eclipse.core.runtime.CoreException
        Sets the hit count attribute of this breakpoint. If this breakpoint is currently disabled and the hit count is set greater than -1, this breakpoint is automatically enabled.
        Parameters:
        count - the new hit count
        Throws:
        org.eclipse.core.runtime.CoreException - if unable to set the property on this breakpoint's underlying marker
      • isExpired

        boolean isExpired()
                   throws org.eclipse.core.runtime.CoreException
        Returns whether this breakpoint has expired.
        Returns:
        whether this breakpoint has expired
        Throws:
        org.eclipse.core.runtime.CoreException - if unable to access the property from this breakpoint's underlying marker
      • setExpired

        void setExpired​(boolean expired)
                 throws org.eclipse.core.runtime.CoreException
        Sets whether this breakpoint's hit count has expired.
        Parameters:
        expired - set expired state
        Throws:
        org.eclipse.core.runtime.CoreException - if unable to access the property from this breakpoint's underlying marker