org.eclipse.lsp4j

Class WorkDoneProgressBegin

java.lang.Object

org.eclipse.lsp4j.WorkDoneProgressBegin

All Implemented Interfaces:

WorkDoneProgressNotification

public class WorkDoneProgressBegin
extends java.lang.Object
implements WorkDoneProgressNotification

The $/progress notification payload to start progress reporting.

Since 3.15.0

Constructor Summary

Constructors

Constructor and Description
WorkDoneProgressBegin()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Boolean	getCancellable() Controls if a cancel button should show to allow the user to cancel the long running operation.
WorkDoneProgressKind	getKind() Always return begin
java.lang.String	getMessage() Optional, more detailed associated progress message.
java.lang.Integer	getPercentage() Optional progress percentage to display (value 100 is considered 100%).
java.lang.String	getTitle() Mandatory title of the progress operation.
int	hashCode()
void	setCancellable(java.lang.Boolean cancellable) Controls if a cancel button should show to allow the user to cancel the long running operation.
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%).
void	setTitle(java.lang.String title) Mandatory title of the progress operation.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkDoneProgressBegin

public WorkDoneProgressBegin()

Method Detail

getKind

public WorkDoneProgressKind getKind()

Always return begin

Specified by:

getKind in interface WorkDoneProgressNotification

getTitle

@Pure
public java.lang.String getTitle()

Mandatory title of the progress operation. Used to briefly inform about the kind of operation being performed.

Examples: "Indexing" or "Linking dependencies".

setTitle

public void setTitle(java.lang.String title)

Mandatory title of the progress operation. Used to briefly inform about the kind of operation being performed.

Examples: "Indexing" or "Linking dependencies".

getCancellable

@Pure
public java.lang.Boolean getCancellable()

Controls if a cancel button should show to allow the user to cancel the long running operation. Clients that don't support cancellation are allowed to ignore the setting.

setCancellable

public void setCancellable(java.lang.Boolean cancellable)

Controls if a cancel button should show to allow the user to cancel the long running operation. Clients that don't support cancellation are allowed to ignore the setting.

getMessage

@Pure
public java.lang.String getMessage()

Optional, more detailed associated progress message. Contains complementary information to the 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 title.

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

getPercentage

@Pure
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

@Pure
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

@Pure
public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

@Pure
public int hashCode()

Overrides:

hashCode in class java.lang.Object