org.eclipse.lsp4j

Class TextDocumentPositionAndWorkDoneProgressParams

java.lang.Object

org.eclipse.lsp4j.TextDocumentPositionParams

org.eclipse.lsp4j.TextDocumentPositionAndWorkDoneProgressParams

All Implemented Interfaces:

WorkDoneProgressParams

Direct Known Subclasses:

CallHierarchyPrepareParams, HoverParams, LinkedEditingRangeParams, PrepareRenameParams, RenameParams, SignatureHelpParams, TextDocumentPositionAndWorkDoneProgressAndPartialResultParams, TypeHierarchyPrepareParams

public abstract class TextDocumentPositionAndWorkDoneProgressParams
extends TextDocumentPositionParams
implements WorkDoneProgressParams

Abstract class which extends TextDocumentPosition and implements work done progress request parameter. It is not present in protocol specification, so it's just "dry" class.

Since 3.15.0

Constructor Summary

Constructors

Constructor and Description
TextDocumentPositionAndWorkDoneProgressParams()
TextDocumentPositionAndWorkDoneProgressParams(TextDocumentIdentifier textDocument, Position position)

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>	getWorkDoneToken() An optional token that a server can use to report work done progress.
int	hashCode()
void	setWorkDoneToken(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,java.lang.Integer> workDoneToken) An optional token that a server can use to report work done progress.
void	setWorkDoneToken(java.lang.Integer workDoneToken)
void	setWorkDoneToken(java.lang.String workDoneToken)
java.lang.String	toString()

Methods inherited from class org.eclipse.lsp4j.TextDocumentPositionParams

getPosition, getTextDocument, setPosition, setTextDocument

Methods inherited from class java.lang.Object

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

Constructor Detail

TextDocumentPositionAndWorkDoneProgressParams

public TextDocumentPositionAndWorkDoneProgressParams()

TextDocumentPositionAndWorkDoneProgressParams

public TextDocumentPositionAndWorkDoneProgressParams(TextDocumentIdentifier textDocument,
                                                     Position position)

Method Detail

getWorkDoneToken

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

An optional token that a server can use to report work done progress.

Specified by:

getWorkDoneToken in interface WorkDoneProgressParams

setWorkDoneToken

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

An optional token that a server can use to report work done progress.

Specified by:

setWorkDoneToken in interface WorkDoneProgressParams

setWorkDoneToken

public void setWorkDoneToken(java.lang.String workDoneToken)

setWorkDoneToken

public void setWorkDoneToken(java.lang.Integer workDoneToken)

toString

@Pure
public java.lang.String toString()

Overrides:

toString in class TextDocumentPositionParams

equals

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

Overrides:

equals in class TextDocumentPositionParams

hashCode

@Pure
public int hashCode()

Overrides:

hashCode in class TextDocumentPositionParams