Package org.eclipse.lsp4j.services

Interface WorkspaceService

  • public interface WorkspaceService

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default java.util.concurrent.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.
      void didChangeConfiguration​(DidChangeConfigurationParams params)
      A notification sent from the client to the server to signal the change of configuration settings.
      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.
      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.
      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.
      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.
      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.
      default java.util.concurrent.CompletableFuture<java.lang.Object> executeCommand​(ExecuteCommandParams params)
      The workspace/executeCommand request is sent from the client to the server to trigger command execution on the server.
      default java.util.concurrent.CompletableFuture<WorkspaceSymbol> resolveWorkspaceSymbol​(WorkspaceSymbol workspaceSymbol)
      The request is sent from the client to the server to resolve additional information for a given workspace symbol.
      default java.util.concurrent.CompletableFuture<org.eclipse.lsp4j.jsonrpc.messages.Either<java.util.List<? extends SymbolInformation>,​java.util.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.
      default java.util.concurrent.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.
      default java.util.concurrent.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.
      default java.util.concurrent.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

      • executeCommand

        default java.util.concurrent.CompletableFuture<java.lang.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: ExecuteCommandRegistrationOptions

      • resolveWorkspaceSymbol

        default java.util.concurrent.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

      • didChangeConfiguration

        void didChangeConfiguration​(DidChangeConfigurationParams params)
        A notification sent from the client to the server to signal the change of configuration settings.

      • didChangeWatchedFiles

        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.

      • didChangeWorkspaceFolders

        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

      • willCreateFiles

        default java.util.concurrent.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

      • didCreateFiles

        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

      • willRenameFiles

        default java.util.concurrent.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

      • didRenameFiles

        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

      • willDeleteFiles

        default java.util.concurrent.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

      • didDeleteFiles

        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

      • diagnostic

        default java.util.concurrent.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