org.eclipse.lsp4j

Class ProgressParams

java.lang.Object

org.eclipse.lsp4j.ProgressParams

public class ProgressParams
extends java.lang.Object

The base protocol offers also support to report progress in a generic fashion. This mechanism can be used to report any kind of progress including work done progress (usually used to report progress in the user interface using a progress bar) and partial result progress to support streaming of results. A progress notification has the following properties: Since 3.15.0

Constructor Summary

Constructors

Constructor and Description
ProgressParams()
ProgressParams(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,java.lang.Integer> token, org.eclipse.lsp4j.jsonrpc.messages.Either<WorkDoneProgressNotification,java.lang.Object> value)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,java.lang.Integer>	getToken() The progress token provided by the client or server.
org.eclipse.lsp4j.jsonrpc.messages.Either<WorkDoneProgressNotification,java.lang.Object>	getValue() The progress data.
int	hashCode()
void	setToken(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,java.lang.Integer> token) The progress token provided by the client or server.
void	setToken(java.lang.Integer token)
void	setToken(java.lang.String token)
void	setValue(org.eclipse.lsp4j.jsonrpc.messages.Either<WorkDoneProgressNotification,java.lang.Object> value) The progress data.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressParams

public ProgressParams()

ProgressParams

public ProgressParams(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,java.lang.Integer> token,
                      org.eclipse.lsp4j.jsonrpc.messages.Either<WorkDoneProgressNotification,java.lang.Object> value)

Method Detail

getToken

@Pure
public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,java.lang.Integer> getToken()

The progress token provided by the client or server.

setToken

public void setToken(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,java.lang.Integer> token)

The progress token provided by the client or server.

setToken

public void setToken(java.lang.String token)

setToken

public void setToken(java.lang.Integer token)

getValue

@Pure
public org.eclipse.lsp4j.jsonrpc.messages.Either<WorkDoneProgressNotification,java.lang.Object> getValue()

The progress data.

setValue

public void setValue(org.eclipse.lsp4j.jsonrpc.messages.Either<WorkDoneProgressNotification,java.lang.Object> value)

The progress data.

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