public class ProgressStartEventArguments
extends java.lang.Object
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 client has passed the value true for the 'supportsProgressReporting' capability of the 'initialize' request.
Constructor and Description |
---|
ProgressStartEventArguments() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.Boolean |
getCancellable()
If true, the request that reports progress may be canceled with a 'cancel' request.
|
java.lang.String |
getMessage()
Optional, more detailed progress message.
|
java.lang.Double |
getPercentage()
Optional progress percentage to display (value range: 0 to 100).
|
java.lang.String |
getProgressId()
An ID that must 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()
Mandatory (short) title of the progress reporting.
|
int |
hashCode() |
void |
setCancellable(java.lang.Boolean cancellable)
If true, the request that reports progress may be canceled with a 'cancel' request.
|
void |
setMessage(java.lang.String message)
Optional, more detailed progress message.
|
void |
setPercentage(java.lang.Double percentage)
Optional progress percentage to display (value range: 0 to 100).
|
void |
setProgressId(java.lang.String progressId)
An ID that must 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)
Mandatory (short) title of the progress reporting.
|
java.lang.String |
toString() |
@Pure public java.lang.String getProgressId()
IDs must be unique within a debug session.
public void setProgressId(java.lang.String progressId)
IDs must be unique within a debug session.
@Pure public java.lang.String getTitle()
public void setTitle(java.lang.String title)
@Pure public java.lang.Integer getRequestId()
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.
public void setRequestId(java.lang.Integer requestId)
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.
@Pure public java.lang.Boolean getCancellable()
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.
public void setCancellable(java.lang.Boolean cancellable)
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.
@Pure public java.lang.String getMessage()
This is an optional property.
public void setMessage(java.lang.String message)
This is an optional property.
@Pure public java.lang.Double getPercentage()
This is an optional property.
public void setPercentage(java.lang.Double percentage)
This is an optional property.
@Pure public java.lang.String toString()
toString
in class java.lang.Object
@Pure public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
@Pure public int hashCode()
hashCode
in class java.lang.Object