Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class TextDocumentClientCapabilities

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

Text document specific client capabilities.

Field Summary

Modifier and TypeField and Description
private CallHierarchyCapabilities
callHierarchy

Capabilities specific to textDocument/prepareCallHierarchy.

private CodeActionCapabilities
codeAction

Capabilities specific to the textDocument/codeAction

private CodeLensCapabilities
codeLens

Capabilities specific to the textDocument/codeLens

private ColorProviderCapabilities
colorProvider

Capabilities specific to the textDocument/documentColor and the textDocument/colorPresentation request.

private CompletionCapabilities
completion

Capabilities specific to the textDocument/completion

private DeclarationCapabilities
declaration

Capabilities specific to the textDocument/declaration

Since 3.14.0

private DefinitionCapabilities
definition

Capabilities specific to the textDocument/definition

Since 3.14.0

private DiagnosticCapabilities
diagnostic

Capabilities specific to the diagnostic pull model.

private DocumentHighlightCapabilities
documentHighlight

Capabilities specific to the textDocument/documentHighlight

private DocumentLinkCapabilities
documentLink

Capabilities specific to the textDocument/documentLink

private DocumentSymbolCapabilities
documentSymbol

Capabilities specific to the textDocument/documentSymbol

private FoldingRangeCapabilities
foldingRange

Capabilities specific to textDocument/foldingRange requests.

private FormattingCapabilities
formatting

Capabilities specific to the textDocument/formatting

private HoverCapabilities
hover

Capabilities specific to the textDocument/hover

private ImplementationCapabilities
implementation

Capabilities specific to the textDocument/implementation

Since 3.6.0

private InlayHintCapabilities
inlayHint

Capabilities specific to the textDocument/inlayHint request.

private InlineValueCapabilities
inlineValue

Client capabilities specific to inline values.

private LinkedEditingRangeCapabilities
linkedEditingRange

Capabilities specific to the textDocument/linkedEditingRange request.

private MonikerCapabilities
moniker

Capabilities specific to the textDocument/moniker request.

private OnTypeFormattingCapabilities
onTypeFormatting

Capabilities specific to the textDocument/onTypeFormatting

private PublishDiagnosticsCapabilities
publishDiagnostics

Capabilities specific to textDocument/publishDiagnostics.

private RangeFormattingCapabilities
rangeFormatting

Capabilities specific to the textDocument/rangeFormatting

private ReferencesCapabilities
references

Capabilities specific to the textDocument/references

private RenameCapabilities
rename

Capabilities specific to the textDocument/rename

private SelectionRangeCapabilities
selectionRange

Capabilities specific to `textDocument/selectionRange` requests

Since 3.15.0

private SemanticTokensCapabilities
semanticTokens

Capabilities specific to textDocument/semanticTokens.

private SignatureHelpCapabilities
signatureHelp

Capabilities specific to the textDocument/signatureHelp

private SynchronizationCapabilities
private TypeDefinitionCapabilities
typeDefinition

Capabilities specific to the textDocument/typeDefinition

Since 3.6.0

private TypeHierarchyCapabilities
typeHierarchy

Capabilities specific to textDocument/prepareTypeHierarchy.

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 CallHierarchyCapabilities
getCallHierarchy()

Capabilities specific to textDocument/prepareCallHierarchy.

public CodeActionCapabilities
getCodeAction()

Capabilities specific to the textDocument/codeAction

public CodeLensCapabilities
getCodeLens()

Capabilities specific to the textDocument/codeLens

public ColorProviderCapabilities
getColorProvider()

Capabilities specific to the textDocument/documentColor and the textDocument/colorPresentation request.

public CompletionCapabilities
getCompletion()

Capabilities specific to the textDocument/completion

public DeclarationCapabilities
getDeclaration()

Capabilities specific to the textDocument/declaration

Since 3.14.0

public DefinitionCapabilities
getDefinition()

Capabilities specific to the textDocument/definition

Since 3.14.0

public DiagnosticCapabilities
getDiagnostic()

Capabilities specific to the diagnostic pull model.

public DocumentHighlightCapabilities
getDocumentHighlight()

Capabilities specific to the textDocument/documentHighlight

public DocumentSymbolCapabilities
getDocumentSymbol()

Capabilities specific to the textDocument/documentSymbol

public FoldingRangeCapabilities
getFoldingRange()

Capabilities specific to textDocument/foldingRange requests.

public FormattingCapabilities
getFormatting()

Capabilities specific to the textDocument/formatting

public HoverCapabilities
getHover()

Capabilities specific to the textDocument/hover

public ImplementationCapabilities
getImplementation()

Capabilities specific to the textDocument/implementation

Since 3.6.0

public InlayHintCapabilities
getInlayHint()

Capabilities specific to the textDocument/inlayHint request.

public InlineValueCapabilities
getInlineValue()

Client capabilities specific to inline values.

public LinkedEditingRangeCapabilities
getLinkedEditingRange()

Capabilities specific to the textDocument/linkedEditingRange request.

public MonikerCapabilities
getMoniker()

Capabilities specific to the textDocument/moniker request.

public OnTypeFormattingCapabilities
getOnTypeFormatting()

Capabilities specific to the textDocument/onTypeFormatting

public PublishDiagnosticsCapabilities
getPublishDiagnostics()

Capabilities specific to textDocument/publishDiagnostics.

public RangeFormattingCapabilities
getRangeFormatting()

Capabilities specific to the textDocument/rangeFormatting

public ReferencesCapabilities
getReferences()

Capabilities specific to the textDocument/references

public RenameCapabilities
getRename()

Capabilities specific to the textDocument/rename

public SelectionRangeCapabilities
getSelectionRange()

Capabilities specific to `textDocument/selectionRange` requests

Since 3.15.0

public SemanticTokensCapabilities
getSemanticTokens()

Capabilities specific to textDocument/semanticTokens.

public SignatureHelpCapabilities
getSignatureHelp()

Capabilities specific to the textDocument/signatureHelp

public SynchronizationCapabilities
public TypeDefinitionCapabilities
getTypeDefinition()

Capabilities specific to the textDocument/typeDefinition

Since 3.6.0

public TypeHierarchyCapabilities
getTypeHierarchy()

Capabilities specific to textDocument/prepareTypeHierarchy.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
setCallHierarchy(final CallHierarchyCapabilities callHierarchy)

Capabilities specific to textDocument/prepareCallHierarchy.

public void
setCodeAction(final CodeActionCapabilities codeAction)

Capabilities specific to the textDocument/codeAction

public void
setCodeLens(final CodeLensCapabilities codeLens)

Capabilities specific to the textDocument/codeLens

public void
setColorProvider(final ColorProviderCapabilities colorProvider)

Capabilities specific to the textDocument/documentColor and the textDocument/colorPresentation request.

public void
setCompletion(final CompletionCapabilities completion)

Capabilities specific to the textDocument/completion

public void
setDeclaration(final DeclarationCapabilities declaration)

Capabilities specific to the textDocument/declaration

Since 3.14.0

public void
setDefinition(final DefinitionCapabilities definition)

Capabilities specific to the textDocument/definition

Since 3.14.0

public void
setDiagnostic(final DiagnosticCapabilities diagnostic)

Capabilities specific to the diagnostic pull model.

public void
setDocumentHighlight(final DocumentHighlightCapabilities documentHighlight)

Capabilities specific to the textDocument/documentHighlight

public void
setDocumentSymbol(final DocumentSymbolCapabilities documentSymbol)

Capabilities specific to the textDocument/documentSymbol

public void
setFoldingRange(final FoldingRangeCapabilities foldingRange)

Capabilities specific to textDocument/foldingRange requests.

public void
setFormatting(final FormattingCapabilities formatting)

Capabilities specific to the textDocument/formatting

public void
setHover(final HoverCapabilities hover)

Capabilities specific to the textDocument/hover

public void
setImplementation(final ImplementationCapabilities implementation)

Capabilities specific to the textDocument/implementation

Since 3.6.0

public void
setInlayHint(final InlayHintCapabilities inlayHint)

Capabilities specific to the textDocument/inlayHint request.

public void
setInlineValue(final InlineValueCapabilities inlineValue)

Client capabilities specific to inline values.

public void
setLinkedEditingRange(final LinkedEditingRangeCapabilities linkedEditingRange)

Capabilities specific to the textDocument/linkedEditingRange request.

public void
setMoniker(final MonikerCapabilities moniker)

Capabilities specific to the textDocument/moniker request.

public void
setOnTypeFormatting(final OnTypeFormattingCapabilities onTypeFormatting)

Capabilities specific to the textDocument/onTypeFormatting

public void
setPublishDiagnostics(final PublishDiagnosticsCapabilities publishDiagnostics)

Capabilities specific to textDocument/publishDiagnostics.

public void
setRangeFormatting(final RangeFormattingCapabilities rangeFormatting)

Capabilities specific to the textDocument/rangeFormatting

public void
setReferences(final ReferencesCapabilities references)

Capabilities specific to the textDocument/references

public void
setRename(final RenameCapabilities rename)

Capabilities specific to the textDocument/rename

public void
setSelectionRange(final SelectionRangeCapabilities selectionRange)

Capabilities specific to `textDocument/selectionRange` requests

Since 3.15.0

public void
setSemanticTokens(final SemanticTokensCapabilities semanticTokens)

Capabilities specific to textDocument/semanticTokens.

public void
setSignatureHelp(final SignatureHelpCapabilities signatureHelp)

Capabilities specific to the textDocument/signatureHelp

public void
public void
setTypeDefinition(final TypeDefinitionCapabilities typeDefinition)

Capabilities specific to the textDocument/typeDefinition

Since 3.6.0

public void
setTypeHierarchy(final TypeHierarchyCapabilities typeHierarchy)

Capabilities specific to textDocument/prepareTypeHierarchy.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

callHierarchyback to summary
private CallHierarchyCapabilities callHierarchy

Capabilities specific to textDocument/prepareCallHierarchy.

Since 3.16.0

codeActionback to summary
private CodeActionCapabilities codeAction

Capabilities specific to the textDocument/codeAction

codeLensback to summary
private CodeLensCapabilities codeLens

Capabilities specific to the textDocument/codeLens

colorProviderback to summary
private ColorProviderCapabilities colorProvider

Capabilities specific to the textDocument/documentColor and the textDocument/colorPresentation request.

Since 3.6.0

completionback to summary
private CompletionCapabilities completion

Capabilities specific to the textDocument/completion

declarationback to summary
private DeclarationCapabilities declaration

Capabilities specific to the textDocument/declaration

Since 3.14.0

definitionback to summary
private DefinitionCapabilities definition

Capabilities specific to the textDocument/definition

Since 3.14.0

diagnosticback to summary
private DiagnosticCapabilities diagnostic

Capabilities specific to the diagnostic pull model.

Since 3.17.0

documentHighlightback to summary
private DocumentHighlightCapabilities documentHighlight

Capabilities specific to the textDocument/documentHighlight

documentSymbolback to summary
private DocumentSymbolCapabilities documentSymbol

Capabilities specific to the textDocument/documentSymbol

foldingRangeback to summary
private FoldingRangeCapabilities foldingRange

Capabilities specific to textDocument/foldingRange requests.

Since 3.10.0

formattingback to summary
private FormattingCapabilities formatting

Capabilities specific to the textDocument/formatting

hoverback to summary
private HoverCapabilities hover

Capabilities specific to the textDocument/hover

implementationback to summary
private ImplementationCapabilities implementation

Capabilities specific to the textDocument/implementation

Since 3.6.0

inlayHintback to summary
private InlayHintCapabilities inlayHint

Capabilities specific to the textDocument/inlayHint request.

Since 3.17.0

inlineValueback to summary
private InlineValueCapabilities inlineValue

Client capabilities specific to inline values.

Since 3.17.0

linkedEditingRangeback to summary
private LinkedEditingRangeCapabilities linkedEditingRange

Capabilities specific to the textDocument/linkedEditingRange request.

Since 3.16.0

monikerback to summary
private MonikerCapabilities moniker

Capabilities specific to the textDocument/moniker request.

Since 3.16.0

onTypeFormattingback to summary
private OnTypeFormattingCapabilities onTypeFormatting

Capabilities specific to the textDocument/onTypeFormatting

publishDiagnosticsback to summary
private PublishDiagnosticsCapabilities publishDiagnostics

Capabilities specific to textDocument/publishDiagnostics.

rangeFormattingback to summary
private RangeFormattingCapabilities rangeFormatting

Capabilities specific to the textDocument/rangeFormatting

referencesback to summary
private ReferencesCapabilities references

Capabilities specific to the textDocument/references

renameback to summary
private RenameCapabilities rename

Capabilities specific to the textDocument/rename

selectionRangeback to summary
private SelectionRangeCapabilities selectionRange

Capabilities specific to `textDocument/selectionRange` requests

Since 3.15.0

semanticTokensback to summary
private SemanticTokensCapabilities semanticTokens

Capabilities specific to textDocument/semanticTokens.

Since 3.16.0

signatureHelpback to summary
private SignatureHelpCapabilities signatureHelp

Capabilities specific to the textDocument/signatureHelp

synchronizationback to summary
private SynchronizationCapabilities synchronization
typeDefinitionback to summary
private TypeDefinitionCapabilities typeDefinition

Capabilities specific to the textDocument/typeDefinition

Since 3.6.0

typeHierarchyback to summary
private TypeHierarchyCapabilities typeHierarchy

Capabilities specific to textDocument/prepareTypeHierarchy.

Since 3.17.0

Constructor Detail

TextDocumentClientCapabilitiesback to summary
public TextDocumentClientCapabilities()

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
getCallHierarchyback to summary
public CallHierarchyCapabilities getCallHierarchy()

Capabilities specific to textDocument/prepareCallHierarchy.

Since 3.16.0

getCodeActionback to summary
public CodeActionCapabilities getCodeAction()

Capabilities specific to the textDocument/codeAction

getCodeLensback to summary
public CodeLensCapabilities getCodeLens()

Capabilities specific to the textDocument/codeLens

getColorProviderback to summary
public ColorProviderCapabilities getColorProvider()

Capabilities specific to the textDocument/documentColor and the textDocument/colorPresentation request.

Since 3.6.0

getCompletionback to summary
public CompletionCapabilities getCompletion()

Capabilities specific to the textDocument/completion

getDeclarationback to summary
public DeclarationCapabilities getDeclaration()

Capabilities specific to the textDocument/declaration

Since 3.14.0

getDefinitionback to summary
public DefinitionCapabilities getDefinition()

Capabilities specific to the textDocument/definition

Since 3.14.0

getDiagnosticback to summary
public DiagnosticCapabilities getDiagnostic()

Capabilities specific to the diagnostic pull model.

Since 3.17.0

getDocumentHighlightback to summary
public DocumentHighlightCapabilities getDocumentHighlight()

Capabilities specific to the textDocument/documentHighlight

getDocumentSymbolback to summary
public DocumentSymbolCapabilities getDocumentSymbol()

Capabilities specific to the textDocument/documentSymbol

getFoldingRangeback to summary
public FoldingRangeCapabilities getFoldingRange()

Capabilities specific to textDocument/foldingRange requests.

Since 3.10.0

getFormattingback to summary
public FormattingCapabilities getFormatting()

Capabilities specific to the textDocument/formatting

getHoverback to summary
public HoverCapabilities getHover()

Capabilities specific to the textDocument/hover

getImplementationback to summary
public ImplementationCapabilities getImplementation()

Capabilities specific to the textDocument/implementation

Since 3.6.0

getInlayHintback to summary
public InlayHintCapabilities getInlayHint()

Capabilities specific to the textDocument/inlayHint request.

Since 3.17.0

getInlineValueback to summary
public InlineValueCapabilities getInlineValue()

Client capabilities specific to inline values.

Since 3.17.0

getLinkedEditingRangeback to summary
public LinkedEditingRangeCapabilities getLinkedEditingRange()

Capabilities specific to the textDocument/linkedEditingRange request.

Since 3.16.0

getMonikerback to summary
public MonikerCapabilities getMoniker()

Capabilities specific to the textDocument/moniker request.

Since 3.16.0

getOnTypeFormattingback to summary
public OnTypeFormattingCapabilities getOnTypeFormatting()

Capabilities specific to the textDocument/onTypeFormatting

getPublishDiagnosticsback to summary
public PublishDiagnosticsCapabilities getPublishDiagnostics()

Capabilities specific to textDocument/publishDiagnostics.

getRangeFormattingback to summary
public RangeFormattingCapabilities getRangeFormatting()

Capabilities specific to the textDocument/rangeFormatting

getReferencesback to summary
public ReferencesCapabilities getReferences()

Capabilities specific to the textDocument/references

getRenameback to summary
public RenameCapabilities getRename()

Capabilities specific to the textDocument/rename

getSelectionRangeback to summary
public SelectionRangeCapabilities getSelectionRange()

Capabilities specific to `textDocument/selectionRange` requests

Since 3.15.0

getSemanticTokensback to summary
public SemanticTokensCapabilities getSemanticTokens()

Capabilities specific to textDocument/semanticTokens.

Since 3.16.0

getSignatureHelpback to summary
public SignatureHelpCapabilities getSignatureHelp()

Capabilities specific to the textDocument/signatureHelp

getSynchronizationback to summary
public SynchronizationCapabilities getSynchronization()
getTypeDefinitionback to summary
public TypeDefinitionCapabilities getTypeDefinition()

Capabilities specific to the textDocument/typeDefinition

Since 3.6.0

getTypeHierarchyback to summary
public TypeHierarchyCapabilities getTypeHierarchy()

Capabilities specific to textDocument/prepareTypeHierarchy.

Since 3.17.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
setCallHierarchyback to summary
public void setCallHierarchy(final CallHierarchyCapabilities callHierarchy)

Capabilities specific to textDocument/prepareCallHierarchy.

Since 3.16.0

setCodeActionback to summary
public void setCodeAction(final CodeActionCapabilities codeAction)

Capabilities specific to the textDocument/codeAction

setCodeLensback to summary
public void setCodeLens(final CodeLensCapabilities codeLens)

Capabilities specific to the textDocument/codeLens

setColorProviderback to summary
public void setColorProvider(final ColorProviderCapabilities colorProvider)

Capabilities specific to the textDocument/documentColor and the textDocument/colorPresentation request.

Since 3.6.0

setCompletionback to summary
public void setCompletion(final CompletionCapabilities completion)

Capabilities specific to the textDocument/completion

setDeclarationback to summary
public void setDeclaration(final DeclarationCapabilities declaration)

Capabilities specific to the textDocument/declaration

Since 3.14.0

setDefinitionback to summary
public void setDefinition(final DefinitionCapabilities definition)

Capabilities specific to the textDocument/definition

Since 3.14.0

setDiagnosticback to summary
public void setDiagnostic(final DiagnosticCapabilities diagnostic)

Capabilities specific to the diagnostic pull model.

Since 3.17.0

setDocumentHighlightback to summary
public void setDocumentHighlight(final DocumentHighlightCapabilities documentHighlight)

Capabilities specific to the textDocument/documentHighlight

setDocumentSymbolback to summary
public void setDocumentSymbol(final DocumentSymbolCapabilities documentSymbol)

Capabilities specific to the textDocument/documentSymbol

setFoldingRangeback to summary
public void setFoldingRange(final FoldingRangeCapabilities foldingRange)

Capabilities specific to textDocument/foldingRange requests.

Since 3.10.0

setFormattingback to summary
public void setFormatting(final FormattingCapabilities formatting)

Capabilities specific to the textDocument/formatting

setHoverback to summary
public void setHover(final HoverCapabilities hover)

Capabilities specific to the textDocument/hover

setImplementationback to summary
public void setImplementation(final ImplementationCapabilities implementation)

Capabilities specific to the textDocument/implementation

Since 3.6.0

setInlayHintback to summary
public void setInlayHint(final InlayHintCapabilities inlayHint)

Capabilities specific to the textDocument/inlayHint request.

Since 3.17.0

setInlineValueback to summary
public void setInlineValue(final InlineValueCapabilities inlineValue)

Client capabilities specific to inline values.

Since 3.17.0

setLinkedEditingRangeback to summary
public void setLinkedEditingRange(final LinkedEditingRangeCapabilities linkedEditingRange)

Capabilities specific to the textDocument/linkedEditingRange request.

Since 3.16.0

setMonikerback to summary
public void setMoniker(final MonikerCapabilities moniker)

Capabilities specific to the textDocument/moniker request.

Since 3.16.0

setOnTypeFormattingback to summary
public void setOnTypeFormatting(final OnTypeFormattingCapabilities onTypeFormatting)

Capabilities specific to the textDocument/onTypeFormatting

setPublishDiagnosticsback to summary
public void setPublishDiagnostics(final PublishDiagnosticsCapabilities publishDiagnostics)

Capabilities specific to textDocument/publishDiagnostics.

setRangeFormattingback to summary
public void setRangeFormatting(final RangeFormattingCapabilities rangeFormatting)

Capabilities specific to the textDocument/rangeFormatting

setReferencesback to summary
public void setReferences(final ReferencesCapabilities references)

Capabilities specific to the textDocument/references

setRenameback to summary
public void setRename(final RenameCapabilities rename)

Capabilities specific to the textDocument/rename

setSelectionRangeback to summary
public void setSelectionRange(final SelectionRangeCapabilities selectionRange)

Capabilities specific to `textDocument/selectionRange` requests

Since 3.15.0

setSemanticTokensback to summary
public void setSemanticTokens(final SemanticTokensCapabilities semanticTokens)

Capabilities specific to textDocument/semanticTokens.

Since 3.16.0

setSignatureHelpback to summary
public void setSignatureHelp(final SignatureHelpCapabilities signatureHelp)

Capabilities specific to the textDocument/signatureHelp

setSynchronizationback to summary
public void setSynchronization(final SynchronizationCapabilities synchronization)
setTypeDefinitionback to summary
public void setTypeDefinition(final TypeDefinitionCapabilities typeDefinition)

Capabilities specific to the textDocument/typeDefinition

Since 3.6.0

setTypeHierarchyback to summary
public void setTypeHierarchy(final TypeHierarchyCapabilities typeHierarchy)

Capabilities specific to textDocument/prepareTypeHierarchy.

Since 3.17.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