Package org.eclipse.lsp4j

Class WorkDoneProgressReport

java.lang.Object

org.eclipse.lsp4j.WorkDoneProgressReport

All Implemented Interfaces:

WorkDoneProgressNotification

public class WorkDoneProgressReport
extends java.lang.Object
implements WorkDoneProgressNotification

The notification payload about progress reporting.

Since 3.15.0

Constructor Summary

Constructors

Constructor	Description
WorkDoneProgressReport()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.Boolean	getCancellable()	Controls enablement state of a cancel button.
WorkDoneProgressKind	getKind()	Always return report
java.lang.String	getMessage()	Optional, more detailed associated progress message.
java.lang.Integer	getPercentage()	Optional progress percentage to display (value 100 is considered 100%).
int	hashCode()
void	setCancellable(java.lang.Boolean cancellable)	Controls enablement state of a cancel button.
void	setMessage(java.lang.String message)	Optional, more detailed associated progress message.
void	setPercentage(java.lang.Integer percentage)	Optional progress percentage to display (value 100 is considered 100%).
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkDoneProgressReport

public WorkDoneProgressReport()

Method Detail

getKind

public WorkDoneProgressKind getKind()

Always return report

Specified by:

getKind in interface WorkDoneProgressNotification

getCancellable

public java.lang.Boolean getCancellable()

Controls enablement state of a cancel button. This property is only valid if a cancel button got requested in the WorkDoneProgressBegin payload.

Clients that don't support cancellation or don't support control the button's enablement state are allowed to ignore the setting.

setCancellable

public void setCancellable(java.lang.Boolean cancellable)

Controls enablement state of a cancel button. This property is only valid if a cancel button got requested in the WorkDoneProgressBegin payload.

Clients that don't support cancellation or don't support control the button's enablement state are allowed to ignore the setting.

getMessage

public java.lang.String getMessage()

Optional, more detailed associated progress message. Contains complementary information to the WorkDoneProgressBegin.title.

Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". If unset, the previous progress message (if any) is still valid.

setMessage

public void setMessage(java.lang.String message)

Optional, more detailed associated progress message. Contains complementary information to the WorkDoneProgressBegin.title.

Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". If unset, the previous progress message (if any) is still valid.

getPercentage

public java.lang.Integer getPercentage()

Optional progress percentage to display (value 100 is considered 100%). If not provided infinite progress is assumed and clients are allowed to ignore the `percentage` value in subsequent in report notifications.

The value should be steadily rising. Clients are free to ignore values that are not following this rule.

setPercentage

public void setPercentage(java.lang.Integer percentage)

Optional progress percentage to display (value 100 is considered 100%). If not provided infinite progress is assumed and clients are allowed to ignore the `percentage` value in subsequent in report notifications.

The value should be steadily rising. Clients are free to ignore values that are not following this rule.

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