Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class WorkspaceClientCapabilities

extends Object
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
org.eclipse.lsp4j.jsonrpc.util.ToStringBuilder

Workspace specific client capabilities.

Field Summary

Modifier and TypeField and Description
private Boolean
applyEdit

The client supports applying batch edits to the workspace by supporting the request 'workspace/applyEdit'.

private CodeLensWorkspaceCapabilities
codeLens

Capabilities specific to the code lens requests scoped to the workspace.

private Boolean
configuration

The client supports `workspace/configuration` requests.

private DiagnosticWorkspaceCapabilities
diagnostics

Client workspace capabilities specific to diagnostics.

private DidChangeConfigurationCapabilities
didChangeConfiguration

Capabilities specific to the `workspace/didChangeConfiguration` notification.

private DidChangeWatchedFilesCapabilities
didChangeWatchedFiles

Capabilities specific to the `workspace/didChangeWatchedFiles` notification.

private ExecuteCommandCapabilities
executeCommand

Capabilities specific to the `workspace/executeCommand` request.

private FileOperationsWorkspaceCapabilities
fileOperations

The client has support for file requests/notifications.

private InlayHintWorkspaceCapabilities
inlayHint

Client workspace capabilities specific to inlay hints.

private InlineValueWorkspaceCapabilities
inlineValue

Client workspace capabilities specific to inline values.

private SemanticTokensWorkspaceCapabilities
semanticTokens

Capabilities specific to the semantic token requests scoped to the workspace.

private SymbolCapabilities
symbol

Capabilities specific to the `workspace/symbol` request.

private WorkspaceEditCapabilities
workspaceEdit

Capabilities specific to WorkspaceEdits

private Boolean
workspaceFolders

The client has support for workspace folders.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(final Object obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public Boolean
getApplyEdit()

The client supports applying batch edits to the workspace by supporting the request 'workspace/applyEdit'.

public CodeLensWorkspaceCapabilities
getCodeLens()

Capabilities specific to the code lens requests scoped to the workspace.

public Boolean
getConfiguration()

The client supports `workspace/configuration` requests.

public DiagnosticWorkspaceCapabilities
getDiagnostics()

Client workspace capabilities specific to diagnostics.

public DidChangeConfigurationCapabilities
getDidChangeConfiguration()

Capabilities specific to the `workspace/didChangeConfiguration` notification.

public DidChangeWatchedFilesCapabilities
getDidChangeWatchedFiles()

Capabilities specific to the `workspace/didChangeWatchedFiles` notification.

public ExecuteCommandCapabilities
getExecuteCommand()

Capabilities specific to the `workspace/executeCommand` request.

public FileOperationsWorkspaceCapabilities
getFileOperations()

The client has support for file requests/notifications.

public InlayHintWorkspaceCapabilities
getInlayHint()

Client workspace capabilities specific to inlay hints.

public InlineValueWorkspaceCapabilities
getInlineValue()

Client workspace capabilities specific to inline values.

public SemanticTokensWorkspaceCapabilities
getSemanticTokens()

Capabilities specific to the semantic token requests scoped to the workspace.

public SymbolCapabilities
getSymbol()

Capabilities specific to the `workspace/symbol` request.

public WorkspaceEditCapabilities
getWorkspaceEdit()

Capabilities specific to WorkspaceEdits

public Boolean
getWorkspaceFolders()

The client has support for workspace folders.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
setApplyEdit(final Boolean applyEdit)

The client supports applying batch edits to the workspace by supporting the request 'workspace/applyEdit'.

public void
setCodeLens(final CodeLensWorkspaceCapabilities codeLens)

Capabilities specific to the code lens requests scoped to the workspace.

public void
setConfiguration(final Boolean configuration)

The client supports `workspace/configuration` requests.

public void
setDiagnostics(final DiagnosticWorkspaceCapabilities diagnostics)

Client workspace capabilities specific to diagnostics.

public void
setDidChangeConfiguration(final DidChangeConfigurationCapabilities didChangeConfiguration)

Capabilities specific to the `workspace/didChangeConfiguration` notification.

public void
setDidChangeWatchedFiles(final DidChangeWatchedFilesCapabilities didChangeWatchedFiles)

Capabilities specific to the `workspace/didChangeWatchedFiles` notification.

public void
setExecuteCommand(final ExecuteCommandCapabilities executeCommand)

Capabilities specific to the `workspace/executeCommand` request.

public void
setFileOperations(final FileOperationsWorkspaceCapabilities fileOperations)

The client has support for file requests/notifications.

public void
setInlayHint(final InlayHintWorkspaceCapabilities inlayHint)

Client workspace capabilities specific to inlay hints.

public void
setInlineValue(final InlineValueWorkspaceCapabilities inlineValue)

Client workspace capabilities specific to inline values.

public void
setSemanticTokens(final SemanticTokensWorkspaceCapabilities semanticTokens)

Capabilities specific to the semantic token requests scoped to the workspace.

public void
setSymbol(final SymbolCapabilities symbol)

Capabilities specific to the `workspace/symbol` request.

public void
setWorkspaceEdit(final WorkspaceEditCapabilities workspaceEdit)

Capabilities specific to WorkspaceEdits

public void
setWorkspaceFolders(final Boolean workspaceFolders)

The client has support for workspace folders.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

applyEditback to summary
private Boolean applyEdit

The client supports applying batch edits to the workspace by supporting the request 'workspace/applyEdit'.

codeLensback to summary
private CodeLensWorkspaceCapabilities codeLens

Capabilities specific to the code lens requests scoped to the workspace.

Since 3.16.0

configurationback to summary
private Boolean configuration

The client supports `workspace/configuration` requests.

Since 3.6.0

diagnosticsback to summary
private DiagnosticWorkspaceCapabilities diagnostics

Client workspace capabilities specific to diagnostics.

Since 3.17.0

didChangeConfigurationback to summary
private DidChangeConfigurationCapabilities didChangeConfiguration

Capabilities specific to the `workspace/didChangeConfiguration` notification.

didChangeWatchedFilesback to summary
private DidChangeWatchedFilesCapabilities didChangeWatchedFiles

Capabilities specific to the `workspace/didChangeWatchedFiles` notification.

executeCommandback to summary
private ExecuteCommandCapabilities executeCommand

Capabilities specific to the `workspace/executeCommand` request.

fileOperationsback to summary
private FileOperationsWorkspaceCapabilities fileOperations

The client has support for file requests/notifications.

Since 3.16.0

inlayHintback to summary
private InlayHintWorkspaceCapabilities inlayHint

Client workspace capabilities specific to inlay hints.

Since 3.17.0

inlineValueback to summary
private InlineValueWorkspaceCapabilities inlineValue

Client workspace capabilities specific to inline values.

Since 3.17.0

semanticTokensback to summary
private SemanticTokensWorkspaceCapabilities semanticTokens

Capabilities specific to the semantic token requests scoped to the workspace.

Since 3.16.0

symbolback to summary
private SymbolCapabilities symbol

Capabilities specific to the `workspace/symbol` request.

workspaceEditback to summary
private WorkspaceEditCapabilities workspaceEdit

Capabilities specific to WorkspaceEdits

workspaceFoldersback to summary
private Boolean workspaceFolders

The client has support for workspace folders.

Since 3.6.0

Constructor Detail

WorkspaceClientCapabilitiesback to summary
public WorkspaceClientCapabilities()

Method Detail

equalsback to summary
public boolean equals(final Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
getApplyEditback to summary
public Boolean getApplyEdit()

The client supports applying batch edits to the workspace by supporting the request 'workspace/applyEdit'.

getCodeLensback to summary
public CodeLensWorkspaceCapabilities getCodeLens()

Capabilities specific to the code lens requests scoped to the workspace.

Since 3.16.0

getConfigurationback to summary
public Boolean getConfiguration()

The client supports `workspace/configuration` requests.

Since 3.6.0

getDiagnosticsback to summary
public DiagnosticWorkspaceCapabilities getDiagnostics()

Client workspace capabilities specific to diagnostics.

Since 3.17.0

getDidChangeConfigurationback to summary
public DidChangeConfigurationCapabilities getDidChangeConfiguration()

Capabilities specific to the `workspace/didChangeConfiguration` notification.

getDidChangeWatchedFilesback to summary
public DidChangeWatchedFilesCapabilities getDidChangeWatchedFiles()

Capabilities specific to the `workspace/didChangeWatchedFiles` notification.

getExecuteCommandback to summary
public ExecuteCommandCapabilities getExecuteCommand()

Capabilities specific to the `workspace/executeCommand` request.

getFileOperationsback to summary
public FileOperationsWorkspaceCapabilities getFileOperations()

The client has support for file requests/notifications.

Since 3.16.0

getInlayHintback to summary
public InlayHintWorkspaceCapabilities getInlayHint()

Client workspace capabilities specific to inlay hints.

Since 3.17.0

getInlineValueback to summary
public InlineValueWorkspaceCapabilities getInlineValue()

Client workspace capabilities specific to inline values.

Since 3.17.0

getSemanticTokensback to summary
public SemanticTokensWorkspaceCapabilities getSemanticTokens()

Capabilities specific to the semantic token requests scoped to the workspace.

Since 3.16.0

getSymbolback to summary
public SymbolCapabilities getSymbol()

Capabilities specific to the `workspace/symbol` request.

getWorkspaceEditback to summary
public WorkspaceEditCapabilities getWorkspaceEdit()

Capabilities specific to WorkspaceEdits

getWorkspaceFoldersback to summary
public Boolean getWorkspaceFolders()

The client has support for workspace folders.

Since 3.6.0

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override
setApplyEditback to summary
public void setApplyEdit(final Boolean applyEdit)

The client supports applying batch edits to the workspace by supporting the request 'workspace/applyEdit'.

setCodeLensback to summary
public void setCodeLens(final CodeLensWorkspaceCapabilities codeLens)

Capabilities specific to the code lens requests scoped to the workspace.

Since 3.16.0

setConfigurationback to summary
public void setConfiguration(final Boolean configuration)

The client supports `workspace/configuration` requests.

Since 3.6.0

setDiagnosticsback to summary
public void setDiagnostics(final DiagnosticWorkspaceCapabilities diagnostics)

Client workspace capabilities specific to diagnostics.

Since 3.17.0

setDidChangeConfigurationback to summary
public void setDidChangeConfiguration(final DidChangeConfigurationCapabilities didChangeConfiguration)

Capabilities specific to the `workspace/didChangeConfiguration` notification.

setDidChangeWatchedFilesback to summary
public void setDidChangeWatchedFiles(final DidChangeWatchedFilesCapabilities didChangeWatchedFiles)

Capabilities specific to the `workspace/didChangeWatchedFiles` notification.

setExecuteCommandback to summary
public void setExecuteCommand(final ExecuteCommandCapabilities executeCommand)

Capabilities specific to the `workspace/executeCommand` request.

setFileOperationsback to summary
public void setFileOperations(final FileOperationsWorkspaceCapabilities fileOperations)

The client has support for file requests/notifications.

Since 3.16.0

setInlayHintback to summary
public void setInlayHint(final InlayHintWorkspaceCapabilities inlayHint)

Client workspace capabilities specific to inlay hints.

Since 3.17.0

setInlineValueback to summary
public void setInlineValue(final InlineValueWorkspaceCapabilities inlineValue)

Client workspace capabilities specific to inline values.

Since 3.17.0

setSemanticTokensback to summary
public void setSemanticTokens(final SemanticTokensWorkspaceCapabilities semanticTokens)

Capabilities specific to the semantic token requests scoped to the workspace.

Since 3.16.0

setSymbolback to summary
public void setSymbol(final SymbolCapabilities symbol)

Capabilities specific to the `workspace/symbol` request.

setWorkspaceEditback to summary
public void setWorkspaceEdit(final WorkspaceEditCapabilities workspaceEdit)

Capabilities specific to WorkspaceEdits

setWorkspaceFoldersback to summary
public void setWorkspaceFolders(final Boolean workspaceFolders)

The client has support for workspace folders.

Since 3.6.0

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override