TextDocumentService (org.eclipse.lsp4j 0.6.0 API)

```
public interface TextDocumentService
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default java.util.concurrent.CompletableFuture<java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<Command,CodeAction>>>`	`codeAction(CodeActionParams params)` The code action request is sent from the client to the server to compute commands for a given text document and range.
`default java.util.concurrent.CompletableFuture<java.util.List<? extends CodeLens>>`	`codeLens(CodeLensParams params)` The code lens request is sent from the client to the server to compute code lenses for a given text document.
`default java.util.concurrent.CompletableFuture<java.util.List<ColorPresentation>>`	`colorPresentation(ColorPresentationParams params)` The color presentation request is sent from the client to the server to obtain a list of presentations for a color value at a given location.
`default java.util.concurrent.CompletableFuture<org.eclipse.lsp4j.jsonrpc.messages.Either<java.util.List<CompletionItem>,CompletionList>>`	`completion(CompletionParams position)` The Completion request is sent from the client to the server to compute completion items at a given cursor position.
`default java.util.concurrent.CompletableFuture<java.util.List<? extends Location>>`	`definition(TextDocumentPositionParams position)` The goto definition request is sent from the client to the server to resolve the definition location of a symbol at a given text document position.
`void`	`didChange(DidChangeTextDocumentParams params)` The document change notification is sent from the client to the server to signal changes to a text document.
`void`	`didClose(DidCloseTextDocumentParams params)` The document close notification is sent from the client to the server when the document got closed in the client.
`void`	`didOpen(DidOpenTextDocumentParams params)` The document open notification is sent from the client to the server to signal newly opened text documents.
`void`	`didSave(DidSaveTextDocumentParams params)` The document save notification is sent from the client to the server when the document for saved in the client.
`default java.util.concurrent.CompletableFuture<java.util.List<ColorInformation>>`	`documentColor(DocumentColorParams params)` The document color request is sent from the client to the server to list all color refereces found in a given text document.
`default java.util.concurrent.CompletableFuture<java.util.List<? extends DocumentHighlight>>`	`documentHighlight(TextDocumentPositionParams position)` The document highlight request is sent from the client to the server to to resolve a document highlights for a given text document position.
`default java.util.concurrent.CompletableFuture<java.util.List<DocumentLink>>`	`documentLink(DocumentLinkParams params)` The document links request is sent from the client to the server to request the location of links in a document.
`default java.util.concurrent.CompletableFuture<DocumentLink>`	`documentLinkResolve(DocumentLink params)` The document link resolve request is sent from the client to the server to resolve the target of a given document link.
`default java.util.concurrent.CompletableFuture<java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<SymbolInformation,DocumentSymbol>>>`	`documentSymbol(DocumentSymbolParams params)` The document symbol request is sent from the client to the server to list all symbols found in a given text document.
`default java.util.concurrent.CompletableFuture<java.util.List<FoldingRange>>`	`foldingRange(FoldingRangeRequestParams params)` The folding range request is sent from the client to the server to return all folding ranges found in a given text document.
`default java.util.concurrent.CompletableFuture<java.util.List<? extends TextEdit>>`	`formatting(DocumentFormattingParams params)` The document formatting request is sent from the client to the server to format a whole document.
`default java.util.concurrent.CompletableFuture<Hover>`	`hover(TextDocumentPositionParams position)` The hover request is sent from the client to the server to request hover information at a given text document position.
`default java.util.concurrent.CompletableFuture<java.util.List<? extends Location>>`	`implementation(TextDocumentPositionParams position)` The goto implementation request is sent from the client to the server to resolve the implementation location of a symbol at a given text document position.
`default java.util.concurrent.CompletableFuture<java.util.List<? extends TextEdit>>`	`onTypeFormatting(DocumentOnTypeFormattingParams params)` The document on type formatting request is sent from the client to the server to format parts of the document during typing.
`default java.util.concurrent.CompletableFuture<org.eclipse.lsp4j.jsonrpc.messages.Either<Range,PrepareRenameResult>>`	`prepareRename(TextDocumentPositionParams params)` The prepare rename request is sent from the client to the server to setup and test the validity of a rename operation at a given location.
`default java.util.concurrent.CompletableFuture<java.util.List<? extends TextEdit>>`	`rangeFormatting(DocumentRangeFormattingParams params)` The document range formatting request is sent from the client to the server to format a given range in a document.
`default java.util.concurrent.CompletableFuture<java.util.List<? extends Location>>`	`references(ReferenceParams params)` The references request is sent from the client to the server to resolve project-wide references for the symbol denoted by the given text document position.
`default java.util.concurrent.CompletableFuture<WorkspaceEdit>`	`rename(RenameParams params)` The rename request is sent from the client to the server to do a workspace wide rename of a symbol.
`default java.util.concurrent.CompletableFuture<CodeLens>`	`resolveCodeLens(CodeLens unresolved)` The code lens resolve request is sent from the client to the server to resolve the command for a given code lens item.
`default java.util.concurrent.CompletableFuture<CompletionItem>`	`resolveCompletionItem(CompletionItem unresolved)` The request is sent from the client to the server to resolve additional information for a given completion item.
`default java.util.concurrent.CompletableFuture<SignatureHelp>`	`signatureHelp(TextDocumentPositionParams position)` The signature help request is sent from the client to the server to request signature information at a given cursor position.
`default java.util.concurrent.CompletableFuture<java.util.List<? extends Location>>`	`typeDefinition(TextDocumentPositionParams position)` The goto type definition request is sent from the client to the server to resolve the type definition location of a symbol at a given text document position.
`default void`	`willSave(WillSaveTextDocumentParams params)` The document will save notification is sent from the client to the server before the document is actually saved.
`default java.util.concurrent.CompletableFuture<java.util.List<TextEdit>>`	`willSaveWaitUntil(WillSaveTextDocumentParams params)` The document will save request is sent from the client to the server before the document is actually saved.

- Method Detail
  - completion
```
default java.util.concurrent.CompletableFuture<org.eclipse.lsp4j.jsonrpc.messages.Either<java.util.List<CompletionItem>,CompletionList>> completion(CompletionParams position)
```
    The Completion request is sent from the client to the server to compute completion items at a given cursor position. Completion items are presented in the IntelliSense user interface. If computing complete completion items is expensive servers can additional provide a handler for the resolve completion item request. This request is sent when a completion item is selected in the user interface. Registration Options: CompletionRegistrationOptions
  - resolveCompletionItem
```
default java.util.concurrent.CompletableFuture<CompletionItem> resolveCompletionItem(CompletionItem unresolved)
```
    The request is sent from the client to the server to resolve additional information for a given completion item.
  - hover
```
default java.util.concurrent.CompletableFuture<Hover> hover(TextDocumentPositionParams position)
```
    The hover request is sent from the client to the server to request hover information at a given text document position. Registration Options: TextDocumentRegistrationOptions
  - signatureHelp
```
default java.util.concurrent.CompletableFuture<SignatureHelp> signatureHelp(TextDocumentPositionParams position)
```
    The signature help request is sent from the client to the server to request signature information at a given cursor position. Registration Options: SignatureHelpRegistrationOptions
  - definition
```
default java.util.concurrent.CompletableFuture<java.util.List<? extends Location>> definition(TextDocumentPositionParams position)
```
    The goto definition request is sent from the client to the server to resolve the definition location of a symbol at a given text document position. Registration Options: TextDocumentRegistrationOptions
  - typeDefinition
```
default java.util.concurrent.CompletableFuture<java.util.List<? extends Location>> typeDefinition(TextDocumentPositionParams position)
```
    The goto type definition request is sent from the client to the server to resolve the type definition location of a symbol at a given text document position. Registration Options: TextDocumentRegistrationOptions Since version 3.6.0
  - implementation
```
default java.util.concurrent.CompletableFuture<java.util.List<? extends Location>> implementation(TextDocumentPositionParams position)
```
    The goto implementation request is sent from the client to the server to resolve the implementation location of a symbol at a given text document position. Registration Options: TextDocumentRegistrationOptions Since version 3.6.0
  - references
```
default java.util.concurrent.CompletableFuture<java.util.List<? extends Location>> references(ReferenceParams params)
```
    The references request is sent from the client to the server to resolve project-wide references for the symbol denoted by the given text document position. Registration Options: TextDocumentRegistrationOptions
  - documentHighlight
```
default java.util.concurrent.CompletableFuture<java.util.List<? extends DocumentHighlight>> documentHighlight(TextDocumentPositionParams position)
```
    The document highlight request is sent from the client to the server to to resolve a document highlights for a given text document position. Registration Options: TextDocumentRegistrationOptions
  - documentSymbol
```
default java.util.concurrent.CompletableFuture<java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<SymbolInformation,DocumentSymbol>>> documentSymbol(DocumentSymbolParams params)
```
    The document symbol request is sent from the client to the server to list all symbols found in a given text document. Registration Options: TextDocumentRegistrationOptions
  - codeAction
```
default java.util.concurrent.CompletableFuture<java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<Command,CodeAction>>> codeAction(CodeActionParams params)
```
    The code action request is sent from the client to the server to compute commands for a given text document and range. These commands are typically code fixes to either fix problems or to beautify/refactor code. Registration Options: TextDocumentRegistrationOptions
  - codeLens
```
default java.util.concurrent.CompletableFuture<java.util.List<? extends CodeLens>> codeLens(CodeLensParams params)
```
    The code lens request is sent from the client to the server to compute code lenses for a given text document. Registration Options: CodeLensRegistrationOptions
  - resolveCodeLens
```
default java.util.concurrent.CompletableFuture<CodeLens> resolveCodeLens(CodeLens unresolved)
```
    The code lens resolve request is sent from the client to the server to resolve the command for a given code lens item.
  - formatting
```
default java.util.concurrent.CompletableFuture<java.util.List<? extends TextEdit>> formatting(DocumentFormattingParams params)
```
    The document formatting request is sent from the client to the server to format a whole document. Registration Options: TextDocumentRegistrationOptions
  - rangeFormatting
```
default java.util.concurrent.CompletableFuture<java.util.List<? extends TextEdit>> rangeFormatting(DocumentRangeFormattingParams params)
```
    The document range formatting request is sent from the client to the server to format a given range in a document. Registration Options: TextDocumentRegistrationOptions
  - onTypeFormatting
```
default java.util.concurrent.CompletableFuture<java.util.List<? extends TextEdit>> onTypeFormatting(DocumentOnTypeFormattingParams params)
```
    The document on type formatting request is sent from the client to the server to format parts of the document during typing. Registration Options: DocumentOnTypeFormattingRegistrationOptions
  - rename
```
default java.util.concurrent.CompletableFuture<WorkspaceEdit> rename(RenameParams params)
```
    The rename request is sent from the client to the server to do a workspace wide rename of a symbol. Registration Options: TextDocumentRegistrationOptions
  - didOpen
```
void didOpen(DidOpenTextDocumentParams params)
```
    The document open notification is sent from the client to the server to signal newly opened text documents. The document's truth is now managed by the client and the server must not try to read the document's truth using the document's uri. Registration Options: TextDocumentRegistrationOptions
  - didChange
```
void didChange(DidChangeTextDocumentParams params)
```
    The document change notification is sent from the client to the server to signal changes to a text document. Registration Options: TextDocumentChangeRegistrationOptions
  - didClose
```
void didClose(DidCloseTextDocumentParams params)
```
    The document close notification is sent from the client to the server when the document got closed in the client. The document's truth now exists where the document's uri points to (e.g. if the document's uri is a file uri the truth now exists on disk). Registration Options: TextDocumentRegistrationOptions
  - didSave
```
void didSave(DidSaveTextDocumentParams params)
```
    The document save notification is sent from the client to the server when the document for saved in the client. Registration Options: TextDocumentSaveRegistrationOptions
  - willSave
```
default void willSave(WillSaveTextDocumentParams params)
```
    The document will save notification is sent from the client to the server before the document is actually saved. Registration Options: TextDocumentRegistrationOptions
  - willSaveWaitUntil
```
default java.util.concurrent.CompletableFuture<java.util.List<TextEdit>> willSaveWaitUntil(WillSaveTextDocumentParams params)
```
    The document will save request is sent from the client to the server before the document is actually saved. The request can return an array of TextEdits which will be applied to the text document before it is saved. Please note that clients might drop results if computing the text edits took too long or if a server constantly fails on this request. This is done to keep the save fast and reliable. Registration Options: TextDocumentRegistrationOptions
  - documentLink
```
default java.util.concurrent.CompletableFuture<java.util.List<DocumentLink>> documentLink(DocumentLinkParams params)
```
    The document links request is sent from the client to the server to request the location of links in a document. Registration Options: DocumentLinkRegistrationOptions
  - documentLinkResolve
```
default java.util.concurrent.CompletableFuture<DocumentLink> documentLinkResolve(DocumentLink params)
```
    The document link resolve request is sent from the client to the server to resolve the target of a given document link.
  - documentColor
```
default java.util.concurrent.CompletableFuture<java.util.List<ColorInformation>> documentColor(DocumentColorParams params)
```
    The document color request is sent from the client to the server to list all color refereces found in a given text document. Along with the range, a color value in RGB is returned. Clients can use the result to decorate color references in an editor. For example: - Color boxes showing the actual color next to the reference - Show a color picker when a color reference is edited Since version 3.6.0
  - colorPresentation
```
default java.util.concurrent.CompletableFuture<java.util.List<ColorPresentation>> colorPresentation(ColorPresentationParams params)
```
    The color presentation request is sent from the client to the server to obtain a list of presentations for a color value at a given location. Clients can use the result to - modify a color reference. - show in a color picker and let users pick one of the presentations Since version 3.6.0
  - foldingRange
```
default java.util.concurrent.CompletableFuture<java.util.List<FoldingRange>> foldingRange(FoldingRangeRequestParams params)
```
    The folding range request is sent from the client to the server to return all folding ranges found in a given text document. Since version 3.10.0
  - prepareRename
```
default java.util.concurrent.CompletableFuture<org.eclipse.lsp4j.jsonrpc.messages.Either<Range,PrepareRenameResult>> prepareRename(TextDocumentPositionParams params)
```
    The prepare rename request is sent from the client to the server to setup and test the validity of a rename operation at a given location. Since version 3.12.0

Interface TextDocumentService

Method Summary

Method Detail

completion

resolveCompletionItem

hover

signatureHelp

definition

typeDefinition

implementation

references

documentHighlight

documentSymbol

codeAction

codeLens

resolveCodeLens

formatting

rangeFormatting

onTypeFormatting

rename

didOpen

didChange

didClose

didSave

willSave

willSaveWaitUntil

documentLink

documentLinkResolve

documentColor

colorPresentation

foldingRange

prepareRename