Package org.eclipse.lsp4j

Class ClientCapabilities

java.lang.Object

org.eclipse.lsp4j.ClientCapabilities

public class ClientCapabilities
extends java.lang.Object

`ClientCapabilities` now define capabilities for dynamic registration, workspace and text document features the client supports. The experimental can be used to pass experimental capabilities under development. For future compatibility a `ClientCapabilities` object literal can have more properties set than currently defined. Servers receiving a `ClientCapabilities` object literal with unknown properties should ignore these properties. A missing property should be interpreted as an absence of the capability. If a property is missing that defines sub properties all sub properties should be interpreted as an absence of the capability.

Client capabilities got introduced with the version 3.0 of the protocol. They therefore only describe capabilities that got introduced in 3.x or later. Capabilities that existed in the 2.x version of the protocol are still mandatory for clients. Clients cannot opt out of providing them. So even if a client omits the TextDocumentClientCapabilities.synchronization it is still required that the client provides text document synchronization (e.g. open, changed and close notifications).

Constructor Summary

Constructors

Constructor	Description
ClientCapabilities()
ClientCapabilities(WorkspaceClientCapabilities workspace, TextDocumentClientCapabilities textDocument, java.lang.Object experimental)
ClientCapabilities(WorkspaceClientCapabilities workspace, TextDocumentClientCapabilities textDocument, WindowClientCapabilities window, java.lang.Object experimental)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.Object	getExperimental()	Experimental client capabilities.
GeneralClientCapabilities	getGeneral()	General client capabilities.
NotebookDocumentClientCapabilities	getNotebookDocument()	Capabilities specific to the notebook document support.
TextDocumentClientCapabilities	getTextDocument()	Text document specific client capabilities.
WindowClientCapabilities	getWindow()	Window specific client capabilities.
WorkspaceClientCapabilities	getWorkspace()	Workspace specific client capabilities.
int	hashCode()
void	setExperimental(java.lang.Object experimental)	Experimental client capabilities.
void	setGeneral(GeneralClientCapabilities general)	General client capabilities.
void	setNotebookDocument(NotebookDocumentClientCapabilities notebookDocument)	Capabilities specific to the notebook document support.
void	setTextDocument(TextDocumentClientCapabilities textDocument)	Text document specific client capabilities.
void	setWindow(WindowClientCapabilities window)	Window specific client capabilities.
void	setWorkspace(WorkspaceClientCapabilities workspace)	Workspace specific client capabilities.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClientCapabilities

public ClientCapabilities()

ClientCapabilities

public ClientCapabilities(WorkspaceClientCapabilities workspace,
                          TextDocumentClientCapabilities textDocument,
                          java.lang.Object experimental)

ClientCapabilities

public ClientCapabilities(WorkspaceClientCapabilities workspace,
                          TextDocumentClientCapabilities textDocument,
                          WindowClientCapabilities window,
                          java.lang.Object experimental)

Method Detail

getWorkspace

public WorkspaceClientCapabilities getWorkspace()

Workspace specific client capabilities.

setWorkspace

public void setWorkspace(WorkspaceClientCapabilities workspace)

Workspace specific client capabilities.

getTextDocument

public TextDocumentClientCapabilities getTextDocument()

Text document specific client capabilities.

setTextDocument

public void setTextDocument(TextDocumentClientCapabilities textDocument)

Text document specific client capabilities.

getNotebookDocument

public NotebookDocumentClientCapabilities getNotebookDocument()

Capabilities specific to the notebook document support.

Since 3.17.0

setNotebookDocument

public void setNotebookDocument(NotebookDocumentClientCapabilities notebookDocument)

Capabilities specific to the notebook document support.

Since 3.17.0

getWindow

public WindowClientCapabilities getWindow()

Window specific client capabilities.

setWindow

public void setWindow(WindowClientCapabilities window)

Window specific client capabilities.

getGeneral

public GeneralClientCapabilities getGeneral()

General client capabilities.

Since 3.16.0

setGeneral

public void setGeneral(GeneralClientCapabilities general)

General client capabilities.

Since 3.16.0

getExperimental

public java.lang.Object getExperimental()

Experimental client capabilities.

setExperimental

public void setExperimental(java.lang.Object experimental)

Experimental client capabilities.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object