Package org.eclipse.lsp4j.debug

Class StackFrame

  • public class StackFrame
extends java.lang.Object
    A Stackframe contains the source location.

    • Constructor Summary

      Constructors 
      Constructor Description
      StackFrame()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.Boolean getCanRestart()
      Indicates whether this frame can be restarted with the 'restart' request.
      int getColumn()
      Start position of the range covered by the stack frame.
      java.lang.Integer getEndColumn()
      End position of the range covered by the stack frame.
      java.lang.Integer getEndLine()
      The end line of the range covered by the stack frame.
      int getId()
      An identifier for the stack frame.
      java.lang.String getInstructionPointerReference()
      A memory reference for the current instruction pointer in this frame.
      int getLine()
      The line within the source of the frame.
      org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Integer,​java.lang.String> getModuleId()
      The module associated with this frame, if any.
      java.lang.String getName()
      The name of the stack frame, typically a method name.
      StackFramePresentationHint getPresentationHint()
      A hint for how to present this frame in the UI.
      Source getSource()
      The source of the frame.
      int hashCode()  
      void setCanRestart​(java.lang.Boolean canRestart)
      Indicates whether this frame can be restarted with the 'restart' request.
      void setColumn​(int column)
      Start position of the range covered by the stack frame.
      void setEndColumn​(java.lang.Integer endColumn)
      End position of the range covered by the stack frame.
      void setEndLine​(java.lang.Integer endLine)
      The end line of the range covered by the stack frame.
      void setId​(int id)
      An identifier for the stack frame.
      void setInstructionPointerReference​(java.lang.String instructionPointerReference)
      A memory reference for the current instruction pointer in this frame.
      void setLine​(int line)
      The line within the source of the frame.
      void setModuleId​(java.lang.Integer moduleId)  
      void setModuleId​(java.lang.String moduleId)  
      void setModuleId​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Integer,​java.lang.String> moduleId)
      The module associated with this frame, if any.
      void setName​(java.lang.String name)
      The name of the stack frame, typically a method name.
      void setPresentationHint​(StackFramePresentationHint presentationHint)
      A hint for how to present this frame in the UI.
      void setSource​(Source source)
      The source of the frame.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • StackFrame

        public StackFrame()

    • Method Detail

      • getId

        public int getId()
        An identifier for the stack frame. It must be unique across all threads.

        This id can be used to retrieve the scopes of the frame with the `scopes` request or to restart the execution of a stack frame.

      • setId

        public void setId​(int id)
        An identifier for the stack frame. It must be unique across all threads.

        This id can be used to retrieve the scopes of the frame with the `scopes` request or to restart the execution of a stack frame.

      • getName

        public java.lang.String getName()
        The name of the stack frame, typically a method name.

      • setName

        public void setName​(java.lang.String name)
        The name of the stack frame, typically a method name.

      • getSource

        public Source getSource()
        The source of the frame.

        This is an optional property.

      • setSource

        public void setSource​(Source source)
        The source of the frame.

        This is an optional property.

      • getLine

        public int getLine()
        The line within the source of the frame. If the source attribute is missing or doesn't exist, line is 0 and should be ignored by the client.

      • setLine

        public void setLine​(int line)
        The line within the source of the frame. If the source attribute is missing or doesn't exist, line is 0 and should be ignored by the client.

      • getColumn

        public int getColumn()
        Start position of the range covered by the stack frame. It is measured in UTF-16 code units and the client capability InitializeRequestArguments.getColumnsStartAt1() determines whether it is 0- or 1-based. If attribute `source` is missing or doesn't exist, `column` is 0 and should be ignored by the client.

      • setColumn

        public void setColumn​(int column)
        Start position of the range covered by the stack frame. It is measured in UTF-16 code units and the client capability InitializeRequestArguments.getColumnsStartAt1() determines whether it is 0- or 1-based. If attribute `source` is missing or doesn't exist, `column` is 0 and should be ignored by the client.

      • getEndLine

        public java.lang.Integer getEndLine()
        The end line of the range covered by the stack frame.

        This is an optional property.

      • setEndLine

        public void setEndLine​(java.lang.Integer endLine)
        The end line of the range covered by the stack frame.

        This is an optional property.

      • getEndColumn

        public java.lang.Integer getEndColumn()
        End position of the range covered by the stack frame. 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.

      • setEndColumn

        public void setEndColumn​(java.lang.Integer endColumn)
        End position of the range covered by the stack frame. 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.

      • getCanRestart

        public java.lang.Boolean getCanRestart()
        Indicates whether this frame can be restarted with the 'restart' request. Clients should only use this if the debug adapter supports the 'restart' request and the corresponding capability Capabilities.getSupportsRestartRequest() is true. If a debug adapter has this capability, then `canRestart` defaults to `true` if the property is absent.

        This is an optional property.

        Since 1.45

      • setCanRestart

        public void setCanRestart​(java.lang.Boolean canRestart)
        Indicates whether this frame can be restarted with the 'restart' request. Clients should only use this if the debug adapter supports the 'restart' request and the corresponding capability Capabilities.getSupportsRestartRequest() is true. If a debug adapter has this capability, then `canRestart` defaults to `true` if the property is absent.

        This is an optional property.

        Since 1.45

      • getInstructionPointerReference

        public java.lang.String getInstructionPointerReference()
        A memory reference for the current instruction pointer in this frame.

        This is an optional property.

      • setInstructionPointerReference

        public void setInstructionPointerReference​(java.lang.String instructionPointerReference)
        A memory reference for the current instruction pointer in this frame.

        This is an optional property.

      • getModuleId

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Integer,​java.lang.String> getModuleId()
        The module associated with this frame, if any.

        This is an optional property.

      • setModuleId

        public void setModuleId​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Integer,​java.lang.String> moduleId)
        The module associated with this frame, if any.

        This is an optional property.

      • setModuleId

        public void setModuleId​(java.lang.Integer moduleId)

      • setModuleId

        public void setModuleId​(java.lang.String moduleId)

      • getPresentationHint

        public StackFramePresentationHint getPresentationHint()
        A hint for how to present this frame in the UI.

        A value of 'label' can be used to indicate that the frame is an artificial frame that is used as a visual label or separator. A value of 'subtle' can be used to change the appearance of a frame in a 'subtle' way.

        This is an optional property.

      • setPresentationHint

        public void setPresentationHint​(StackFramePresentationHint presentationHint)
        A hint for how to present this frame in the UI.

        A value of 'label' can be used to indicate that the frame is an artificial frame that is used as a visual label or separator. A value of 'subtle' can be used to change the appearance of a frame in a 'subtle' way.

        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