org.eclipse.lsp4j

Class DocumentFormattingParams

java.lang.Object

org.eclipse.lsp4j.DocumentFormattingParams

All Implemented Interfaces:

WorkDoneProgressParams

public class DocumentFormattingParams
extends java.lang.Object
implements WorkDoneProgressParams

The document formatting request is sent from the server to the client to format a whole document.

Constructor Summary

Constructors

Constructor and Description
DocumentFormattingParams()
DocumentFormattingParams(TextDocumentIdentifier textDocument, FormattingOptions options)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
FormattingOptions	getOptions() The format options
TextDocumentIdentifier	getTextDocument() The document to format.
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	setOptions(FormattingOptions options) The format options
void	setTextDocument(TextDocumentIdentifier textDocument) The document to format.
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 java.lang.Object

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

Constructor Detail

DocumentFormattingParams

public DocumentFormattingParams()

DocumentFormattingParams

public DocumentFormattingParams(TextDocumentIdentifier textDocument,
                                FormattingOptions options)

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)

getTextDocument

@Pure
public TextDocumentIdentifier getTextDocument()

The document to format.

setTextDocument

public void setTextDocument(TextDocumentIdentifier textDocument)

The document to format.

getOptions

@Pure
public FormattingOptions getOptions()

The format options

setOptions

public void setOptions(FormattingOptions options)

The format options

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