Package org.eclipse.lsp4j.debug

Class ProgressStartEventArguments

  • public class ProgressStartEventArguments
extends java.lang.Object
    The event signals that a long running operation is about to start and provides additional information for the client to set up a corresponding progress and cancellation UI.

    The client is free to delay the showing of the UI in order to reduce flicker.

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

    Represents the body of ProgressStartEvent defined in spec.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.Boolean getCancellable()
      If true, the request that reports progress may be cancelled with a 'cancel' request.
      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()
      An ID that can be used in subsequent 'progressUpdate' and 'progressEnd' events to make them refer to the same progress reporting.
      java.lang.Integer getRequestId()
      The request ID that this progress report is related to.
      java.lang.String getTitle()
      Short title of the progress reporting.
      int hashCode()  
      void setCancellable​(java.lang.Boolean cancellable)
      If true, the request that reports progress may be cancelled with a 'cancel' request.
      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)
      An ID that can be used in subsequent 'progressUpdate' and 'progressEnd' events to make them refer to the same progress reporting.
      void setRequestId​(java.lang.Integer requestId)
      The request ID that this progress report is related to.
      void setTitle​(java.lang.String title)
      Short title of the progress reporting.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ProgressStartEventArguments

        public ProgressStartEventArguments()

    • Method Detail

      • getProgressId

        public java.lang.String getProgressId()
        An ID that can be used in subsequent 'progressUpdate' and 'progressEnd' events to make them refer to the same progress reporting.

        IDs must be unique within a debug session.

      • setProgressId

        public void setProgressId​(java.lang.String progressId)
        An ID that can be used in subsequent 'progressUpdate' and 'progressEnd' events to make them refer to the same progress reporting.

        IDs must be unique within a debug session.

      • getTitle

        public java.lang.String getTitle()
        Short title of the progress reporting. Shown in the UI to describe the long running operation.

      • setTitle

        public void setTitle​(java.lang.String title)
        Short title of the progress reporting. Shown in the UI to describe the long running operation.

      • getRequestId

        public java.lang.Integer getRequestId()
        The request ID that this progress report is related to. If specified a debug adapter is expected to emit progress events for the long running request until the request has been either completed or cancelled.

        If the request ID is omitted, the progress report is assumed to be related to some general activity of the debug adapter.

        This is an optional property.

      • setRequestId

        public void setRequestId​(java.lang.Integer requestId)
        The request ID that this progress report is related to. If specified a debug adapter is expected to emit progress events for the long running request until the request has been either completed or cancelled.

        If the request ID is omitted, the progress report is assumed to be related to some general activity of the debug adapter.

        This is an optional property.

      • getCancellable

        public java.lang.Boolean getCancellable()
        If true, the request that reports progress may be cancelled with a 'cancel' request.

        So this property basically controls whether the client should use UX that supports cancellation.

        Clients that don't support cancellation are allowed to ignore the setting.

        This is an optional property.

      • setCancellable

        public void setCancellable​(java.lang.Boolean cancellable)
        If true, the request that reports progress may be cancelled with a 'cancel' request.

        So this property basically controls whether the client should use UX that supports cancellation.

        Clients that don't support cancellation are allowed to ignore the setting.

        This is an optional property.

      • getMessage

        public java.lang.String getMessage()
        More detailed progress message.

        This is an optional property.

      • setMessage

        public void setMessage​(java.lang.String message)
        More detailed progress message.

        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