public interface TextDocumentService
Modifier and Type | Method and Description |
---|---|
default java.util.concurrent.CompletableFuture<java.util.List<CallHierarchyIncomingCall>> |
callHierarchyIncomingCalls(CallHierarchyIncomingCallsParams params)
Provide all incoming calls for an item, e.g all callers for a method.
|
default java.util.concurrent.CompletableFuture<java.util.List<CallHierarchyOutgoingCall>> |
callHierarchyOutgoingCalls(CallHierarchyOutgoingCallsParams params)
Provide all outgoing calls for an item, e.g call calls to functions, methods, or constructors from the given item.
|
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<org.eclipse.lsp4j.jsonrpc.messages.Either<java.util.List<? extends Location>,java.util.List<? extends LocationLink>>> |
declaration(DeclarationParams params)
The go to declaration request is sent from the client to the server to resolve
the declaration location of a symbol at a given text document position.
|
default java.util.concurrent.CompletableFuture<org.eclipse.lsp4j.jsonrpc.messages.Either<java.util.List<? extends Location>,java.util.List<? extends LocationLink>>> |
definition(DefinitionParams params)
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 references found in a given text
document.
|
default java.util.concurrent.CompletableFuture<java.util.List<? extends DocumentHighlight>> |
documentHighlight(DocumentHighlightParams params)
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(HoverParams params)
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<org.eclipse.lsp4j.jsonrpc.messages.Either<java.util.List<? extends Location>,java.util.List<? extends LocationLink>>> |
implementation(ImplementationParams params)
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<java.util.List<CallHierarchyItem>> |
prepareCallHierarchy(CallHierarchyPrepareParams params)
Bootstraps call hierarchy by returning the item that is denoted by the given document
and position.
|
default java.util.concurrent.CompletableFuture<org.eclipse.lsp4j.jsonrpc.messages.Either<Range,PrepareRenameResult>> |
prepareRename(PrepareRenameParams 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<CodeAction> |
resolveCodeAction(CodeAction unresolved)
The request is sent from the client to the server to resolve additional information for a given code action.
|
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<TypeHierarchyItem> |
resolveTypeHierarchy(ResolveTypeHierarchyItemParams params)
The
typeHierarchy/resolve request is sent from the client to the
server to resolve an unresolved type hierarchy
item . |
default java.util.concurrent.CompletableFuture<java.util.List<SelectionRange>> |
selectionRange(SelectionRangeParams params)
The
textDocument/selectionRange request is sent from the client to the server to return
suggested selection ranges at an array of given positions. |
default java.util.concurrent.CompletableFuture<SemanticTokens> |
semanticTokensFull(SemanticTokensParams params)
The
textDocument/semanticTokens/full request is sent from the client to the server to return
the semantic tokens for a whole file. |
default java.util.concurrent.CompletableFuture<org.eclipse.lsp4j.jsonrpc.messages.Either<SemanticTokens,SemanticTokensDelta>> |
semanticTokensFullDelta(SemanticTokensDeltaParams params)
The
textDocument/semanticTokens/full/delta request is sent from the client to the server to return
the semantic tokens delta for a whole file. |
default java.util.concurrent.CompletableFuture<SemanticTokens> |
semanticTokensRange(SemanticTokensRangeParams params)
The
textDocument/semanticTokens/range request is sent from the client to the server to return
the semantic tokens delta for a range. |
default java.util.concurrent.CompletableFuture<SignatureHelp> |
signatureHelp(SignatureHelpParams params)
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<org.eclipse.lsp4j.jsonrpc.messages.Either<java.util.List<? extends Location>,java.util.List<? extends LocationLink>>> |
typeDefinition(TypeDefinitionParams params)
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 java.util.concurrent.CompletableFuture<TypeHierarchyItem> |
typeHierarchy(TypeHierarchyParams params)
The
textDocument/typeHierarchy request is sent from the client to the
server to retrieve a type hierarchy item based on
the cursor position in the text document . |
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.
|
default java.util.concurrent.CompletableFuture<org.eclipse.lsp4j.jsonrpc.messages.Either<java.util.List<CompletionItem>,CompletionList>> completion(CompletionParams position)
default java.util.concurrent.CompletableFuture<CompletionItem> resolveCompletionItem(CompletionItem unresolved)
default java.util.concurrent.CompletableFuture<Hover> hover(HoverParams params)
default java.util.concurrent.CompletableFuture<SignatureHelp> signatureHelp(SignatureHelpParams params)
default java.util.concurrent.CompletableFuture<org.eclipse.lsp4j.jsonrpc.messages.Either<java.util.List<? extends Location>,java.util.List<? extends LocationLink>>> declaration(DeclarationParams params)
default java.util.concurrent.CompletableFuture<org.eclipse.lsp4j.jsonrpc.messages.Either<java.util.List<? extends Location>,java.util.List<? extends LocationLink>>> definition(DefinitionParams params)
default java.util.concurrent.CompletableFuture<org.eclipse.lsp4j.jsonrpc.messages.Either<java.util.List<? extends Location>,java.util.List<? extends LocationLink>>> typeDefinition(TypeDefinitionParams params)
default java.util.concurrent.CompletableFuture<org.eclipse.lsp4j.jsonrpc.messages.Either<java.util.List<? extends Location>,java.util.List<? extends LocationLink>>> implementation(ImplementationParams params)
default java.util.concurrent.CompletableFuture<java.util.List<? extends Location>> references(ReferenceParams params)
default java.util.concurrent.CompletableFuture<java.util.List<? extends DocumentHighlight>> documentHighlight(DocumentHighlightParams params)
default java.util.concurrent.CompletableFuture<java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<SymbolInformation,DocumentSymbol>>> documentSymbol(DocumentSymbolParams params)
TextDocumentRegistrationOptions
Caveat: although the return type allows mixing the
DocumentSymbol
and SymbolInformation
instances into a list do
not do it because the clients cannot accept a heterogeneous list. A list of
DocumentSymbol
instances is only a valid return value if the
textDocument.documentSymbol.hierarchicalDocumentSymbolSupport
is
true
. More details on this difference between the LSP and the LSP4J
can be found here.
default java.util.concurrent.CompletableFuture<java.util.List<org.eclipse.lsp4j.jsonrpc.messages.Either<Command,CodeAction>>> codeAction(CodeActionParams params)
default java.util.concurrent.CompletableFuture<CodeAction> resolveCodeAction(CodeAction unresolved)
default java.util.concurrent.CompletableFuture<java.util.List<? extends CodeLens>> codeLens(CodeLensParams params)
default java.util.concurrent.CompletableFuture<CodeLens> resolveCodeLens(CodeLens unresolved)
default java.util.concurrent.CompletableFuture<java.util.List<? extends TextEdit>> formatting(DocumentFormattingParams params)
default java.util.concurrent.CompletableFuture<java.util.List<? extends TextEdit>> rangeFormatting(DocumentRangeFormattingParams params)
default java.util.concurrent.CompletableFuture<java.util.List<? extends TextEdit>> onTypeFormatting(DocumentOnTypeFormattingParams params)
default java.util.concurrent.CompletableFuture<WorkspaceEdit> rename(RenameParams params)
void didOpen(DidOpenTextDocumentParams params)
void didChange(DidChangeTextDocumentParams params)
void didClose(DidCloseTextDocumentParams params)
void didSave(DidSaveTextDocumentParams params)
default void willSave(WillSaveTextDocumentParams params)
default java.util.concurrent.CompletableFuture<java.util.List<TextEdit>> willSaveWaitUntil(WillSaveTextDocumentParams params)
default java.util.concurrent.CompletableFuture<java.util.List<DocumentLink>> documentLink(DocumentLinkParams params)
default java.util.concurrent.CompletableFuture<DocumentLink> documentLinkResolve(DocumentLink params)
default java.util.concurrent.CompletableFuture<java.util.List<ColorInformation>> documentColor(DocumentColorParams params)
default java.util.concurrent.CompletableFuture<java.util.List<ColorPresentation>> colorPresentation(ColorPresentationParams params)
default java.util.concurrent.CompletableFuture<java.util.List<FoldingRange>> foldingRange(FoldingRangeRequestParams params)
default java.util.concurrent.CompletableFuture<org.eclipse.lsp4j.jsonrpc.messages.Either<Range,PrepareRenameResult>> prepareRename(PrepareRenameParams params)
@Beta default java.util.concurrent.CompletableFuture<TypeHierarchyItem> typeHierarchy(TypeHierarchyParams params)
textDocument/typeHierarchy
request is sent from the client to the
server to retrieve a type hierarchy item
based on
the cursor position in the text document
. This
request would also allow to specify if the item should be resolved and
whether sub- or supertypes are to be resolved. If no type hierarchy item can
be found under the given text document position, resolves to null
.
Note: the textDocument/typeHierarchy
language feature is not yet part of the official LSP specification.
@Beta default java.util.concurrent.CompletableFuture<TypeHierarchyItem> resolveTypeHierarchy(ResolveTypeHierarchyItemParams params)
typeHierarchy/resolve
request is sent from the client to the
server to resolve an unresolved type hierarchy
item
. A type hierarchy item is unresolved if the if the
parents
or the
children
is not defined.
Note: the textDocument/typeHierarchy
language feature is not yet part of the official LSP specification.
@Beta default java.util.concurrent.CompletableFuture<java.util.List<CallHierarchyItem>> prepareCallHierarchy(CallHierarchyPrepareParams params)
@Beta default java.util.concurrent.CompletableFuture<java.util.List<CallHierarchyIncomingCall>> callHierarchyIncomingCalls(CallHierarchyIncomingCallsParams params)
@Beta default java.util.concurrent.CompletableFuture<java.util.List<CallHierarchyOutgoingCall>> callHierarchyOutgoingCalls(CallHierarchyOutgoingCallsParams params)
default java.util.concurrent.CompletableFuture<java.util.List<SelectionRange>> selectionRange(SelectionRangeParams params)
textDocument/selectionRange
request is sent from the client to the server to return
suggested selection ranges at an array of given positions. A selection range is a range around
the cursor position which the user might be interested in selecting.
Since 3.15.0default java.util.concurrent.CompletableFuture<SemanticTokens> semanticTokensFull(SemanticTokensParams params)
textDocument/semanticTokens/full
request is sent from the client to the server to return
the semantic tokens for a whole file.
Since 3.16.0default java.util.concurrent.CompletableFuture<org.eclipse.lsp4j.jsonrpc.messages.Either<SemanticTokens,SemanticTokensDelta>> semanticTokensFullDelta(SemanticTokensDeltaParams params)
textDocument/semanticTokens/full/delta
request is sent from the client to the server to return
the semantic tokens delta for a whole file.
Since 3.16.0default java.util.concurrent.CompletableFuture<SemanticTokens> semanticTokensRange(SemanticTokensRangeParams params)
textDocument/semanticTokens/range
request is sent from the client to the server to return
the semantic tokens delta for a range.
When a user opens a file it can be beneficial to only compute the semantic tokens for the visible range
(faster rendering of the tokens in the user interface). If a server can compute these tokens faster than
for the whole file it can provide a handler for the textDocument/semanticTokens/range request to handle
this case special. Please note that if a client also announces that it will send the
textDocument/semanticTokens/range server should implement this request as well to allow for flicker free
scrolling and semantic coloring of a minimap.
Since 3.16.0