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

Method Summary

Modifier and Type	Method and Description
public default void	cancelProgress(WorkDoneProgressCancelParams params) This notification is sent from the client to the server to cancel a progress initiated on the server side.
public void	exit() A notification to ask the server to exit its process.
public default NotebookDocumentService	getNotebookDocumentService() Provides access to the notebookDocument services.
public TextDocumentService	getTextDocumentService() Provides access to the textDocument services.
public WorkspaceService	getWorkspaceService() Provides access to the workspace services.
public CompletableFuture<InitializeResult>	initialize(InitializeParams params) The initialize request is sent as the first request from the client to the server.
public default void	initialized(InitializedParams params) The initialized notification is sent from the client to the server after the client received the result of the initialize request, but before the client is sending any other request or notification to the server.
public default void	initialized() Deprecated Use `initialized(InitializedParams)` instead.
public default void	setTrace(SetTraceParams params) A notification that should be used by the client to modify the trace setting of the server.
public CompletableFuture<Object>	shutdown() The shutdown request is sent from the client to the server.

Method Detail

cancelProgress	back to summary
public default void cancelProgress(WorkDoneProgressCancelParams params) This notification is sent from the client to the server to cancel a progress initiated on the server side. Since 3.15.0 Annotations @JsonNotification:window/workDoneProgress/cancel

cancelProgress

back to summary

public default void cancelProgress(WorkDoneProgressCancelParams params)

This notification is sent from the client to the server to cancel a progress initiated on the server side.

Since 3.15.0

Annotations

@JsonNotification:window/workDoneProgress/cancel

exit	back to summary
public void exit() A notification to ask the server to exit its process. Annotations @JsonNotification

exit

back to summary

public void exit()

A notification to ask the server to exit its process.

Annotations

@JsonNotification

getNotebookDocumentService	back to summary
public default NotebookDocumentService getNotebookDocumentService() Provides access to the notebookDocument services. Since 3.17.0 Annotations @JsonDelegate

getNotebookDocumentService

back to summary

public default NotebookDocumentService getNotebookDocumentService()

Provides access to the notebookDocument services.

Since 3.17.0

Annotations

@JsonDelegate

getTextDocumentService	back to summary
public TextDocumentService getTextDocumentService() Provides access to the textDocument services. Annotations @JsonDelegate

getTextDocumentService

back to summary

public TextDocumentService getTextDocumentService()

Provides access to the textDocument services.

Annotations

@JsonDelegate

getWorkspaceService	back to summary
public WorkspaceService getWorkspaceService() Provides access to the workspace services. Annotations @JsonDelegate

getWorkspaceService

back to summary

public WorkspaceService getWorkspaceService()

Provides access to the workspace services.

Annotations

@JsonDelegate

initialize back to summary

initialize	back to summary
public CompletableFuture<InitializeResult> initialize(InitializeParams params) The initialize request is sent as the first request from the client to the server. If the server receives requests or notifications before the initialize request, it should act as follows: for a request, the response should be errored with: `org.eclipse.lsp4j.jsonrpc.messages.ResponseErrorCode#ServerNotInitialized`. The message can be picked by the server. notifications should be dropped, except for the exit notification. This will allow the client to exit a server without an initialize request. Until the server has responded to the initialize request with an InitializeResult, the client must not send any additional requests or notifications to the server. During the initialize request, the server is allowed to send the notifications window/showMessage, window/logMessage, and telemetry/event, as well as the request window/showMessageRequest, to the client. Annotations @JsonRequest

public CompletableFuture<InitializeResult> initialize(InitializeParams params)

The initialize request is sent as the first request from the client to the server.

If the server receives requests or notifications before the initialize request, it should act as follows:

for a request, the response should be errored with: org.eclipse.lsp4j.jsonrpc.messages.ResponseErrorCode#ServerNotInitialized. The message can be picked by the server.
notifications should be dropped, except for the exit notification. This will allow the client to exit a server without an initialize request.

Until the server has responded to the initialize request with an InitializeResult, the client must not send any additional requests or notifications to the server.

During the initialize request, the server is allowed to send the notifications window/showMessage, window/logMessage, and telemetry/event, as well as the request window/showMessageRequest, to the client.

Annotations

@JsonRequest

initialized	back to summary
public default void initialized(InitializedParams params) The initialized notification is sent from the client to the server after the client received the result of the initialize request, but before the client is sending any other request or notification to the server. The server can use the initialized notification, for example, to dynamically register capabilities. Annotations @JsonNotification

initialized

back to summary

public default void initialized(InitializedParams params)

The initialized notification is sent from the client to the server after the client received the result of the initialize request, but before the client is sending any other request or notification to the server. The server can use the initialized notification, for example, to dynamically register capabilities.

Annotations

@JsonNotification

initialized	back to summary
public default void initialized() Deprecated Use `initialized(InitializedParams)` instead. Annotations @Deprecated

setTrace	back to summary
public default void setTrace(SetTraceParams params) A notification that should be used by the client to modify the trace setting of the server. Since 3.16.0 Annotations @JsonNotification:$/setTrace

setTrace

back to summary

public default void setTrace(SetTraceParams params)

A notification that should be used by the client to modify the trace setting of the server.

Since 3.16.0

Annotations

@JsonNotification:$/setTrace

shutdown	back to summary
public CompletableFuture<Object> shutdown() The shutdown request is sent from the client to the server. It asks the server to shutdown, but to not exit (otherwise the response might not be delivered correctly to the client). There is a separate exit notification that asks the server to exit. Annotations @JsonRequest

shutdown

back to summary

public CompletableFuture<Object> shutdown()

The shutdown request is sent from the client to the server. It asks the server to shutdown, but to not exit (otherwise the response might not be delivered correctly to the client). There is a separate exit notification that asks the server to exit.

Annotations

@JsonRequest

public Interface LanguageServer

Method Summary

Method Detail