Package org.eclipse.lsp4j.debug

Class ProgressUpdateEventArguments

  • public class ProgressUpdateEventArguments
extends java.lang.Object
    The event signals that the progress reporting needs to be updated with a new message and/or percentage.

    The client does not have to update the UI immediately, but the clients needs to keep track of the message and/or percentage values.

    This event should only be sent if the corresponding capability 'supportsProgressReporting' is true.

    Represents the body of ProgressUpdateEvent defined in spec.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getMessage()
      More detailed progress message.
      java.lang.Double getPercentage()
      Progress percentage to display (value range: 0 to 100).
      java.lang.String getProgressId()
      The ID that was introduced in the initial 'progressStart' event.
      int hashCode()  
      void setMessage​(java.lang.String message)
      More detailed progress message.
      void setPercentage​(java.lang.Double percentage)
      Progress percentage to display (value range: 0 to 100).
      void setProgressId​(java.lang.String progressId)
      The ID that was introduced in the initial 'progressStart' event.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ProgressUpdateEventArguments

        public ProgressUpdateEventArguments()

    • Method Detail

      • getProgressId

        public java.lang.String getProgressId()
        The ID that was introduced in the initial 'progressStart' event.

      • setProgressId

        public void setProgressId​(java.lang.String progressId)
        The ID that was introduced in the initial 'progressStart' event.

      • getMessage

        public java.lang.String getMessage()
        More detailed progress message. If omitted, the previous message (if any) is used.

        This is an optional property.

      • setMessage

        public void setMessage​(java.lang.String message)
        More detailed progress message. If omitted, the previous message (if any) is used.

        This is an optional property.

      • getPercentage

        public java.lang.Double getPercentage()
        Progress percentage to display (value range: 0 to 100). If omitted no percentage is shown.

        This is an optional property.

      • setPercentage

        public void setPercentage​(java.lang.Double percentage)
        Progress percentage to display (value range: 0 to 100). If omitted no percentage is shown.

        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