public class ProgressUpdateEventArguments
extends java.lang.Object
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 client has passed the value true for the 'supportsProgressReporting' capability of the 'initialize' request.
Constructor and Description |
---|
ProgressUpdateEventArguments() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
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()
The ID that was introduced in the initial 'progressStart' event.
|
int |
hashCode() |
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)
The ID that was introduced in the initial 'progressStart' event.
|
java.lang.String |
toString() |
@Pure public java.lang.String getProgressId()
public void setProgressId(java.lang.String progressId)
@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