Package org.eclipse.lsp4j.debug

Class SourceBreakpoint

  • public class SourceBreakpoint
extends java.lang.Object
    Properties of a breakpoint or logpoint passed to the setBreakpoints request.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.Integer getColumn()
      Start position within source line of the breakpoint or logpoint.
      java.lang.String getCondition()
      The expression for conditional breakpoints.
      java.lang.String getHitCondition()
      The expression that controls how many hits of the breakpoint are ignored.
      int getLine()
      The source line of the breakpoint or logpoint.
      java.lang.String getLogMessage()
      If this attribute exists and is non-empty, the debug adapter must not 'break' (stop)
      int hashCode()  
      void setColumn​(java.lang.Integer column)
      Start position within source line of the breakpoint or logpoint.
      void setCondition​(java.lang.String condition)
      The expression for conditional breakpoints.
      void setHitCondition​(java.lang.String hitCondition)
      The expression that controls how many hits of the breakpoint are ignored.
      void setLine​(int line)
      The source line of the breakpoint or logpoint.
      void setLogMessage​(java.lang.String logMessage)
      If this attribute exists and is non-empty, the debug adapter must not 'break' (stop)
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • SourceBreakpoint

        public SourceBreakpoint()

    • Method Detail

      • getLine

        public int getLine()
        The source line of the breakpoint or logpoint.

      • setLine

        public void setLine​(int line)
        The source line of the breakpoint or logpoint.

      • getColumn

        public java.lang.Integer getColumn()
        Start position within source line of the breakpoint or logpoint. It is measured in UTF-16 code units and the client capability InitializeRequestArguments.getColumnsStartAt1() determines whether it is 0- or 1-based.

        This is an optional property.

      • setColumn

        public void setColumn​(java.lang.Integer column)
        Start position within source line of the breakpoint or logpoint. It is measured in UTF-16 code units and the client capability InitializeRequestArguments.getColumnsStartAt1() determines whether it is 0- or 1-based.

        This is an optional property.

      • getCondition

        public java.lang.String getCondition()
        The expression for conditional breakpoints.

        It is only honored by a debug adapter if the corresponding capability Capabilities.getSupportsConditionalBreakpoints() is true.

        This is an optional property.

      • setCondition

        public void setCondition​(java.lang.String condition)
        The expression for conditional breakpoints.

        It is only honored by a debug adapter if the corresponding capability Capabilities.getSupportsConditionalBreakpoints() is true.

        This is an optional property.

      • getHitCondition

        public java.lang.String getHitCondition()
        The expression that controls how many hits of the breakpoint are ignored.

        The debug adapter is expected to interpret the expression as needed.

        The attribute is only honored by a debug adapter if the corresponding capability Capabilities.getSupportsHitConditionalBreakpoints() is true.

        If both this property and `condition` are specified, `hitCondition` should be evaluated only if the `condition` is met, and the debug adapter should stop only if both conditions are met.

        This is an optional property.

      • setHitCondition

        public void setHitCondition​(java.lang.String hitCondition)
        The expression that controls how many hits of the breakpoint are ignored.

        The debug adapter is expected to interpret the expression as needed.

        The attribute is only honored by a debug adapter if the corresponding capability Capabilities.getSupportsHitConditionalBreakpoints() is true.

        If both this property and `condition` are specified, `hitCondition` should be evaluated only if the `condition` is met, and the debug adapter should stop only if both conditions are met.

        This is an optional property.

      • getLogMessage

        public java.lang.String getLogMessage()
        If this attribute exists and is non-empty, the debug adapter must not 'break' (stop)

        but log the message instead. Expressions within {} are interpolated.

        The attribute is only honored by a debug adapter if the corresponding capability Capabilities.getSupportsLogPoints() is true.

        If either `hitCondition` or `condition` is specified, then the message should only be logged if those conditions are met.

        This is an optional property.

      • setLogMessage

        public void setLogMessage​(java.lang.String logMessage)
        If this attribute exists and is non-empty, the debug adapter must not 'break' (stop)

        but log the message instead. Expressions within {} are interpolated.

        The attribute is only honored by a debug adapter if the corresponding capability Capabilities.getSupportsLogPoints() is true.

        If either `hitCondition` or `condition` is specified, then the message should only be logged if those conditions are met.

        This is an optional property.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object