Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.services.WorkspaceService

Method Summary

Modifier and Type	Method and Description
public default CompletableFuture<WorkspaceDiagnosticReport>	diagnostic(WorkspaceDiagnosticParams params) The workspace diagnostic request is sent from the client to the server to ask the server to compute workspace wide diagnostics which previously where pushed from the server to the client.
public void	didChangeConfiguration(DidChangeConfigurationParams params) A notification sent from the client to the server to signal the change of configuration settings.
public void	didChangeWatchedFiles(DidChangeWatchedFilesParams params) The watched files notification is sent from the client to the server when the client detects changes to file watched by the language client.
public default void	didChangeWorkspaceFolders(DidChangeWorkspaceFoldersParams params) The workspace/didChangeWorkspaceFolders notification is sent from the client to the server to inform the server about workspace folder configuration changes.
public default void	didCreateFiles(CreateFilesParams params) The did create files notification is sent from the client to the server when files were created from within the client.
public default void	didDeleteFiles(DeleteFilesParams params) The did delete files notification is sent from the client to the server when files were deleted from within the client.
public default void	didRenameFiles(RenameFilesParams params) The did rename files notification is sent from the client to the server when files were renamed from within the client.
public default CompletableFuture<Object>	executeCommand(ExecuteCommandParams params) The workspace/executeCommand request is sent from the client to the server to trigger command execution on the server.
public default CompletableFuture<WorkspaceSymbol>	resolveWorkspaceSymbol(WorkspaceSymbol workspaceSymbol) The request is sent from the client to the server to resolve additional information for a given workspace symbol.
public default CompletableFuture<Either<List<? extends SymbolInformation>, List<? extends WorkspaceSymbol>>>	symbol(WorkspaceSymbolParams params) The workspace symbol request is sent from the client to the server to list project-wide symbols matching the query string.
public default CompletableFuture<WorkspaceEdit>	willCreateFiles(CreateFilesParams params) The will create files request is sent from the client to the server before files are actually created as long as the creation is triggered from within the client.
public default CompletableFuture<WorkspaceEdit>	willDeleteFiles(DeleteFilesParams params) The will delete files request is sent from the client to the server before files are actually deleted as long as the deletion is triggered from within the client.
public default CompletableFuture<WorkspaceEdit>	willRenameFiles(RenameFilesParams params) The will rename files request is sent from the client to the server before files are actually renamed as long as the rename is triggered from within the client.

Method Detail

diagnostic	back to summary
public default CompletableFuture<WorkspaceDiagnosticReport> diagnostic(WorkspaceDiagnosticParams params) The workspace diagnostic request is sent from the client to the server to ask the server to compute workspace wide diagnostics which previously where pushed from the server to the client. In contrast to the document diagnostic request the workspace request can be long running and is not bound to a specific workspace or document state. If the client supports streaming for the workspace diagnostic pull it is legal to provide a document diagnostic report multiple times for the same document URI. The last one reported will win over previous reports. Since 3.17.0 Annotations @JsonRequest

diagnostic

back to summary

public default CompletableFuture<WorkspaceDiagnosticReport> diagnostic(WorkspaceDiagnosticParams params)

The workspace diagnostic request is sent from the client to the server to ask the server to compute workspace wide diagnostics which previously where pushed from the server to the client. In contrast to the document diagnostic request the workspace request can be long running and is not bound to a specific workspace or document state. If the client supports streaming for the workspace diagnostic pull it is legal to provide a document diagnostic report multiple times for the same document URI. The last one reported will win over previous reports.

Since 3.17.0

Annotations

@JsonRequest

didChangeConfiguration	back to summary
public void didChangeConfiguration(DidChangeConfigurationParams params) A notification sent from the client to the server to signal the change of configuration settings. Annotations @JsonNotification

didChangeConfiguration

back to summary

public void didChangeConfiguration(DidChangeConfigurationParams params)

A notification sent from the client to the server to signal the change of configuration settings.

Annotations

@JsonNotification

didChangeWatchedFiles	back to summary
public void didChangeWatchedFiles(DidChangeWatchedFilesParams params) The watched files notification is sent from the client to the server when the client detects changes to file watched by the language client. Annotations @JsonNotification

didChangeWatchedFiles

back to summary

public void didChangeWatchedFiles(DidChangeWatchedFilesParams params)

The watched files notification is sent from the client to the server when the client detects changes to file watched by the language client.

Annotations

@JsonNotification

didChangeWorkspaceFolders	back to summary
public default void didChangeWorkspaceFolders(DidChangeWorkspaceFoldersParams params) The workspace/didChangeWorkspaceFolders notification is sent from the client to the server to inform the server about workspace folder configuration changes. The notification is sent by default if both ServerCapabilities/workspaceFolders and ClientCapabilities/workspace/workspaceFolders are true; or if the server has registered to receive this notification it first. Since 3.6.0 Annotations @JsonNotification

didChangeWorkspaceFolders

back to summary

public default void didChangeWorkspaceFolders(DidChangeWorkspaceFoldersParams params)

The workspace/didChangeWorkspaceFolders notification is sent from the client to the server to inform the server about workspace folder configuration changes. The notification is sent by default if both ServerCapabilities/workspaceFolders and ClientCapabilities/workspace/workspaceFolders are true; or if the server has registered to receive this notification it first.

Since 3.6.0

Annotations

@JsonNotification

didCreateFiles	back to summary
public default void didCreateFiles(CreateFilesParams params) The did create files notification is sent from the client to the server when files were created from within the client. Since 3.16.0 Annotations @JsonNotification

didCreateFiles

back to summary

public default void didCreateFiles(CreateFilesParams params)

The did create files notification is sent from the client to the server when files were created from within the client.

Since 3.16.0

Annotations

@JsonNotification

didDeleteFiles	back to summary
public default void didDeleteFiles(DeleteFilesParams params) The did delete files notification is sent from the client to the server when files were deleted from within the client. Since 3.16.0 Annotations @JsonNotification

didDeleteFiles

back to summary

public default void didDeleteFiles(DeleteFilesParams params)

The did delete files notification is sent from the client to the server when files were deleted from within the client.

Since 3.16.0

Annotations

@JsonNotification

didRenameFiles	back to summary
public default void didRenameFiles(RenameFilesParams params) The did rename files notification is sent from the client to the server when files were renamed from within the client. Since 3.16.0 Annotations @JsonNotification

didRenameFiles

back to summary

public default void didRenameFiles(RenameFilesParams params)

The did rename files notification is sent from the client to the server when files were renamed from within the client.

Since 3.16.0

Annotations

@JsonNotification

executeCommand back to summary

executeCommand	back to summary
public default CompletableFuture<Object> executeCommand(ExecuteCommandParams params) The workspace/executeCommand request is sent from the client to the server to trigger command execution on the server. In most cases the server creates a WorkspaceEdit structure and applies the changes to the workspace using the request workspace/applyEdit which is sent from the server to the client. Registration Options: `org.eclipse.lsp4j.ExecuteCommandRegistrationOptions` Annotations @JsonRequest

public default CompletableFuture<Object> executeCommand(ExecuteCommandParams params)

The workspace/executeCommand request is sent from the client to the server to trigger command execution on the server. In most cases the server creates a WorkspaceEdit structure and applies the changes to the workspace using the request workspace/applyEdit which is sent from the server to the client.

Registration Options: org.eclipse.lsp4j.ExecuteCommandRegistrationOptions

Annotations

@JsonRequest

resolveWorkspaceSymbol	back to summary
public default CompletableFuture<WorkspaceSymbol> resolveWorkspaceSymbol(WorkspaceSymbol workspaceSymbol) The request is sent from the client to the server to resolve additional information for a given workspace symbol. Since 3.17.0 Annotations @JsonRequest:workspaceSymbol/resolve useSegment:false

resolveWorkspaceSymbol

back to summary

public default CompletableFuture<WorkspaceSymbol> resolveWorkspaceSymbol(WorkspaceSymbol workspaceSymbol)

The request is sent from the client to the server to resolve additional information for a given workspace symbol.

Since 3.17.0

Annotations

@JsonRequest:workspaceSymbol/resolve
useSegment:false

symbol back to summary

symbol	back to summary
public default CompletableFuture<Either<List<? extends SymbolInformation>, List<? extends WorkspaceSymbol>>> symbol(WorkspaceSymbolParams params) The workspace symbol request is sent from the client to the server to list project-wide symbols matching the query string. Registration Options: `org.eclipse.lsp4j.WorkspaceSymbolRegistrationOptions` Annotations @JsonRequest @ResponseJsonAdapter:WorkspaceSymbolResponseAdapter

public default CompletableFuture<Either<List<? extends SymbolInformation>, List<? extends WorkspaceSymbol>>> symbol(WorkspaceSymbolParams params)

The workspace symbol request is sent from the client to the server to list project-wide symbols matching the query string.

Registration Options: org.eclipse.lsp4j.WorkspaceSymbolRegistrationOptions

Annotations

@JsonRequest
@ResponseJsonAdapter:WorkspaceSymbolResponseAdapter

willCreateFiles back to summary

willCreateFiles	back to summary
public default CompletableFuture<WorkspaceEdit> willCreateFiles(CreateFilesParams params) The will create files request is sent from the client to the server before files are actually created as long as the creation is triggered from within the client. The request can return a `WorkspaceEdit` which will be applied to workspace before the files are created. Please note that clients might drop results if computing the edit took too long or if a server constantly fails on this request. This is done to keep creates fast and reliable. Since 3.16.0 Annotations @JsonRequest

public default CompletableFuture<WorkspaceEdit> willCreateFiles(CreateFilesParams params)

The will create files request is sent from the client to the server before files are actually created as long as the creation is triggered from within the client. The request can return a WorkspaceEdit which will be applied to workspace before the files are created. Please note that clients might drop results if computing the edit took too long or if a server constantly fails on this request. This is done to keep creates fast and reliable.

Since 3.16.0

Annotations

@JsonRequest

willDeleteFiles back to summary

willDeleteFiles	back to summary
public default CompletableFuture<WorkspaceEdit> willDeleteFiles(DeleteFilesParams params) The will delete files request is sent from the client to the server before files are actually deleted as long as the deletion is triggered from within the client. The request can return a `WorkspaceEdit` which will be applied to workspace before the files are deleted. Please note that clients might drop results if computing the edit took too long or if a server constantly fails on this request. This is done to keep deletes fast and reliable. Since 3.16.0 Annotations @JsonRequest

public default CompletableFuture<WorkspaceEdit> willDeleteFiles(DeleteFilesParams params)

The will delete files request is sent from the client to the server before files are actually deleted as long as the deletion is triggered from within the client. The request can return a WorkspaceEdit which will be applied to workspace before the files are deleted. Please note that clients might drop results if computing the edit took too long or if a server constantly fails on this request. This is done to keep deletes fast and reliable.

Since 3.16.0

Annotations

@JsonRequest

willRenameFiles back to summary

willRenameFiles	back to summary
public default CompletableFuture<WorkspaceEdit> willRenameFiles(RenameFilesParams params) The will rename files request is sent from the client to the server before files are actually renamed as long as the rename is triggered from within the client. The request can return a `WorkspaceEdit` which will be applied to workspace before the files are renamed. Please note that clients might drop results if computing the edit took too long or if a server constantly fails on this request. This is done to keep renames fast and reliable. Since 3.16.0 Annotations @JsonRequest

public default CompletableFuture<WorkspaceEdit> willRenameFiles(RenameFilesParams params)

The will rename files request is sent from the client to the server before files are actually renamed as long as the rename is triggered from within the client. The request can return a WorkspaceEdit which will be applied to workspace before the files are renamed. Please note that clients might drop results if computing the edit took too long or if a server constantly fails on this request. This is done to keep renames fast and reliable.

Since 3.16.0

Annotations

@JsonRequest

public Interface WorkspaceService

Method Summary

Method Detail