Package org.eclipse.lsp4j.debug

Class Message

  • public class Message
extends java.lang.Object
    A structured message object. Used to return errors from requests.

    • Constructor Summary

      Constructors 
      Constructor Description
      Message()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getFormat()
      A format string for the message.
      int getId()
      Unique (within a debug adapter implementation) identifier for the message.
      java.lang.Boolean getSendTelemetry()
      If true send to telemetry.
      java.lang.Boolean getShowUser()
      If true show user.
      java.lang.String getUrl()
      A url where additional information about this message can be found.
      java.lang.String getUrlLabel()
      A label that is presented to the user as the UI for opening the url.
      java.util.Map<java.lang.String,​java.lang.String> getVariables()
      An object used as a dictionary for looking up the variables in the format string.
      int hashCode()  
      void setFormat​(java.lang.String format)
      A format string for the message.
      void setId​(int id)
      Unique (within a debug adapter implementation) identifier for the message.
      void setSendTelemetry​(java.lang.Boolean sendTelemetry)
      If true send to telemetry.
      void setShowUser​(java.lang.Boolean showUser)
      If true show user.
      void setUrl​(java.lang.String url)
      A url where additional information about this message can be found.
      void setUrlLabel​(java.lang.String urlLabel)
      A label that is presented to the user as the UI for opening the url.
      void setVariables​(java.util.Map<java.lang.String,​java.lang.String> variables)
      An object used as a dictionary for looking up the variables in the format string.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Message

        public Message()

    • Method Detail

      • getId

        public int getId()
        Unique (within a debug adapter implementation) identifier for the message. The purpose of these error IDs is to help extension authors that have the requirement that every user visible error message needs a corresponding error number, so that users or customer support can find information about the specific error more easily.

      • setId

        public void setId​(int id)
        Unique (within a debug adapter implementation) identifier for the message. The purpose of these error IDs is to help extension authors that have the requirement that every user visible error message needs a corresponding error number, so that users or customer support can find information about the specific error more easily.

      • getFormat

        public java.lang.String getFormat()
        A format string for the message. Embedded variables have the form '{name}'.

        If variable name starts with an underscore character, the variable does not contain user data (PII) and can be safely used for telemetry purposes.

      • setFormat

        public void setFormat​(java.lang.String format)
        A format string for the message. Embedded variables have the form '{name}'.

        If variable name starts with an underscore character, the variable does not contain user data (PII) and can be safely used for telemetry purposes.

      • getVariables

        public java.util.Map<java.lang.String,​java.lang.String> getVariables()
        An object used as a dictionary for looking up the variables in the format string.

        This is an optional property.

      • setVariables

        public void setVariables​(java.util.Map<java.lang.String,​java.lang.String> variables)
        An object used as a dictionary for looking up the variables in the format string.

        This is an optional property.

      • getSendTelemetry

        public java.lang.Boolean getSendTelemetry()
        If true send to telemetry.

        This is an optional property.

      • setSendTelemetry

        public void setSendTelemetry​(java.lang.Boolean sendTelemetry)
        If true send to telemetry.

        This is an optional property.

      • getShowUser

        public java.lang.Boolean getShowUser()
        If true show user.

        This is an optional property.

      • setShowUser

        public void setShowUser​(java.lang.Boolean showUser)
        If true show user.

        This is an optional property.

      • getUrl

        public java.lang.String getUrl()
        A url where additional information about this message can be found.

        This is an optional property.

      • setUrl

        public void setUrl​(java.lang.String url)
        A url where additional information about this message can be found.

        This is an optional property.

      • getUrlLabel

        public java.lang.String getUrlLabel()
        A label that is presented to the user as the UI for opening the url.

        This is an optional property.

      • setUrlLabel

        public void setUrlLabel​(java.lang.String urlLabel)
        A label that is presented to the user as the UI for opening the url.

        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