Package org.eclipse.lsp4j

Class ServerCapabilities

  • public class ServerCapabilities
extends java.lang.Object
    The server can signal these capabilities

    • Constructor Detail

      • ServerCapabilities

        public ServerCapabilities()

    • Method Detail

      • getPositionEncoding

        public java.lang.String getPositionEncoding()
        The position encoding the server picked from the encodings offered by the client via the client capability GeneralClientCapabilities.positionEncodings.

        If the client didn't provide any position encodings the only valid value that a server can return is PositionEncodingKind.UTF16.

        If omitted it defaults to PositionEncodingKind.UTF16.

        See PositionEncodingKind for some predefined position encoding kinds.

        Since 3.17.0

      • setPositionEncoding

        public void setPositionEncoding​(java.lang.String positionEncoding)
        The position encoding the server picked from the encodings offered by the client via the client capability GeneralClientCapabilities.positionEncodings.

        If the client didn't provide any position encodings the only valid value that a server can return is PositionEncodingKind.UTF16.

        If omitted it defaults to PositionEncodingKind.UTF16.

        See PositionEncodingKind for some predefined position encoding kinds.

        Since 3.17.0

      • getTextDocumentSync

        public org.eclipse.lsp4j.jsonrpc.messages.Either<TextDocumentSyncKind,​TextDocumentSyncOptions> getTextDocumentSync()
        Defines how text documents are synced. Is either a detailed structure defining each notification or for backwards compatibility the TextDocumentSyncKind number. If omitted it defaults to TextDocumentSyncKind.None.

      • setTextDocumentSync

        public void setTextDocumentSync​(org.eclipse.lsp4j.jsonrpc.messages.Either<TextDocumentSyncKind,​TextDocumentSyncOptions> textDocumentSync)
        Defines how text documents are synced. Is either a detailed structure defining each notification or for backwards compatibility the TextDocumentSyncKind number. If omitted it defaults to TextDocumentSyncKind.None.

      • getHoverProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​HoverOptions> getHoverProvider()
        The server provides hover support.

      • setHoverProvider

        public void setHoverProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​HoverOptions> hoverProvider)
        The server provides hover support.

      • setHoverProvider

        public void setHoverProvider​(java.lang.Boolean hoverProvider)

      • setHoverProvider

        public void setHoverProvider​(HoverOptions hoverProvider)

      • getCompletionProvider

        public CompletionOptions getCompletionProvider()
        The server provides completion support.

      • setCompletionProvider

        public void setCompletionProvider​(CompletionOptions completionProvider)
        The server provides completion support.

      • getSignatureHelpProvider

        public SignatureHelpOptions getSignatureHelpProvider()
        The server provides signature help support.

      • setSignatureHelpProvider

        public void setSignatureHelpProvider​(SignatureHelpOptions signatureHelpProvider)
        The server provides signature help support.

      • getDefinitionProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​DefinitionOptions> getDefinitionProvider()
        The server provides goto definition support.

      • setDefinitionProvider

        public void setDefinitionProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​DefinitionOptions> definitionProvider)
        The server provides goto definition support.

      • setDefinitionProvider

        public void setDefinitionProvider​(java.lang.Boolean definitionProvider)

      • setDefinitionProvider

        public void setDefinitionProvider​(DefinitionOptions definitionProvider)

      • getTypeDefinitionProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​TypeDefinitionRegistrationOptions> getTypeDefinitionProvider()
        The server provides Goto Type Definition support.

        Since 3.6.0

      • setTypeDefinitionProvider

        public void setTypeDefinitionProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​TypeDefinitionRegistrationOptions> typeDefinitionProvider)
        The server provides Goto Type Definition support.

        Since 3.6.0

      • setTypeDefinitionProvider

        public void setTypeDefinitionProvider​(java.lang.Boolean typeDefinitionProvider)

      • getImplementationProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​ImplementationRegistrationOptions> getImplementationProvider()
        The server provides Goto Implementation support.

        Since 3.6.0

      • setImplementationProvider

        public void setImplementationProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​ImplementationRegistrationOptions> implementationProvider)
        The server provides Goto Implementation support.

        Since 3.6.0

      • setImplementationProvider

        public void setImplementationProvider​(java.lang.Boolean implementationProvider)

      • getReferencesProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​ReferenceOptions> getReferencesProvider()
        The server provides find references support.

      • setReferencesProvider

        public void setReferencesProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​ReferenceOptions> referencesProvider)
        The server provides find references support.

      • setReferencesProvider

        public void setReferencesProvider​(java.lang.Boolean referencesProvider)

      • setReferencesProvider

        public void setReferencesProvider​(ReferenceOptions referencesProvider)

      • getDocumentHighlightProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​DocumentHighlightOptions> getDocumentHighlightProvider()
        The server provides document highlight support.

      • setDocumentHighlightProvider

        public void setDocumentHighlightProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​DocumentHighlightOptions> documentHighlightProvider)
        The server provides document highlight support.

      • setDocumentHighlightProvider

        public void setDocumentHighlightProvider​(java.lang.Boolean documentHighlightProvider)

      • setDocumentHighlightProvider

        public void setDocumentHighlightProvider​(DocumentHighlightOptions documentHighlightProvider)

      • getDocumentSymbolProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​DocumentSymbolOptions> getDocumentSymbolProvider()
        The server provides document symbol support.

      • setDocumentSymbolProvider

        public void setDocumentSymbolProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​DocumentSymbolOptions> documentSymbolProvider)
        The server provides document symbol support.

      • setDocumentSymbolProvider

        public void setDocumentSymbolProvider​(java.lang.Boolean documentSymbolProvider)

      • setDocumentSymbolProvider

        public void setDocumentSymbolProvider​(DocumentSymbolOptions documentSymbolProvider)

      • getWorkspaceSymbolProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​WorkspaceSymbolOptions> getWorkspaceSymbolProvider()
        The server provides workspace symbol support.

      • setWorkspaceSymbolProvider

        public void setWorkspaceSymbolProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​WorkspaceSymbolOptions> workspaceSymbolProvider)
        The server provides workspace symbol support.

      • setWorkspaceSymbolProvider

        public void setWorkspaceSymbolProvider​(java.lang.Boolean workspaceSymbolProvider)

      • setWorkspaceSymbolProvider

        public void setWorkspaceSymbolProvider​(WorkspaceSymbolOptions workspaceSymbolProvider)

      • getCodeActionProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​CodeActionOptions> getCodeActionProvider()
        The server provides code actions. The CodeActionOptions return type is only valid if the client signals code action literal support via the property CodeActionCapabilities.codeActionLiteralSupport.

      • setCodeActionProvider

        public void setCodeActionProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​CodeActionOptions> codeActionProvider)
        The server provides code actions. The CodeActionOptions return type is only valid if the client signals code action literal support via the property CodeActionCapabilities.codeActionLiteralSupport.

      • setCodeActionProvider

        public void setCodeActionProvider​(java.lang.Boolean codeActionProvider)

      • setCodeActionProvider

        public void setCodeActionProvider​(CodeActionOptions codeActionProvider)

      • getCodeLensProvider

        public CodeLensOptions getCodeLensProvider()
        The server provides code lens.

      • setCodeLensProvider

        public void setCodeLensProvider​(CodeLensOptions codeLensProvider)
        The server provides code lens.

      • getDocumentFormattingProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​DocumentFormattingOptions> getDocumentFormattingProvider()
        The server provides document formatting.

      • setDocumentFormattingProvider

        public void setDocumentFormattingProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​DocumentFormattingOptions> documentFormattingProvider)
        The server provides document formatting.

      • setDocumentFormattingProvider

        public void setDocumentFormattingProvider​(java.lang.Boolean documentFormattingProvider)

      • setDocumentFormattingProvider

        public void setDocumentFormattingProvider​(DocumentFormattingOptions documentFormattingProvider)

      • getDocumentRangeFormattingProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​DocumentRangeFormattingOptions> getDocumentRangeFormattingProvider()
        The server provides document range formatting.

      • setDocumentRangeFormattingProvider

        public void setDocumentRangeFormattingProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​DocumentRangeFormattingOptions> documentRangeFormattingProvider)
        The server provides document range formatting.

      • setDocumentRangeFormattingProvider

        public void setDocumentRangeFormattingProvider​(java.lang.Boolean documentRangeFormattingProvider)

      • setDocumentRangeFormattingProvider

        public void setDocumentRangeFormattingProvider​(DocumentRangeFormattingOptions documentRangeFormattingProvider)

      • getDocumentOnTypeFormattingProvider

        public DocumentOnTypeFormattingOptions getDocumentOnTypeFormattingProvider()
        The server provides document formatting on typing.

      • setDocumentOnTypeFormattingProvider

        public void setDocumentOnTypeFormattingProvider​(DocumentOnTypeFormattingOptions documentOnTypeFormattingProvider)
        The server provides document formatting on typing.

      • getRenameProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​RenameOptions> getRenameProvider()
        The server provides rename support.

      • setRenameProvider

        public void setRenameProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​RenameOptions> renameProvider)
        The server provides rename support.

      • setRenameProvider

        public void setRenameProvider​(java.lang.Boolean renameProvider)

      • setRenameProvider

        public void setRenameProvider​(RenameOptions renameProvider)

      • getDocumentLinkProvider

        public DocumentLinkOptions getDocumentLinkProvider()
        The server provides document link support.

      • setDocumentLinkProvider

        public void setDocumentLinkProvider​(DocumentLinkOptions documentLinkProvider)
        The server provides document link support.

      • getColorProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​ColorProviderOptions> getColorProvider()
        The server provides color provider support.

        Since 3.6.0

      • setColorProvider

        public void setColorProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​ColorProviderOptions> colorProvider)
        The server provides color provider support.

        Since 3.6.0

      • setColorProvider

        public void setColorProvider​(java.lang.Boolean colorProvider)

      • getFoldingRangeProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​FoldingRangeProviderOptions> getFoldingRangeProvider()
        The server provides folding provider support.

        Since 3.10.0

      • setFoldingRangeProvider

        public void setFoldingRangeProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​FoldingRangeProviderOptions> foldingRangeProvider)
        The server provides folding provider support.

        Since 3.10.0

      • setFoldingRangeProvider

        public void setFoldingRangeProvider​(java.lang.Boolean foldingRangeProvider)

      • getDeclarationProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​DeclarationRegistrationOptions> getDeclarationProvider()
        The server provides go to declaration support.

        Since 3.14.0

      • setDeclarationProvider

        public void setDeclarationProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​DeclarationRegistrationOptions> declarationProvider)
        The server provides go to declaration support.

        Since 3.14.0

      • setDeclarationProvider

        public void setDeclarationProvider​(java.lang.Boolean declarationProvider)

      • getExecuteCommandProvider

        public ExecuteCommandOptions getExecuteCommandProvider()
        The server provides execute command support.

      • setExecuteCommandProvider

        public void setExecuteCommandProvider​(ExecuteCommandOptions executeCommandProvider)
        The server provides execute command support.

      • getTypeHierarchyProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​TypeHierarchyRegistrationOptions> getTypeHierarchyProvider()
        The server provides Type Hierarchy support.

        Since 3.17.0

      • setTypeHierarchyProvider

        public void setTypeHierarchyProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​TypeHierarchyRegistrationOptions> typeHierarchyProvider)
        The server provides Type Hierarchy support.

        Since 3.17.0

      • setTypeHierarchyProvider

        public void setTypeHierarchyProvider​(java.lang.Boolean typeHierarchyProvider)

      • getCallHierarchyProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​CallHierarchyRegistrationOptions> getCallHierarchyProvider()
        The server provides Call Hierarchy support.

        Since 3.16.0

      • setCallHierarchyProvider

        public void setCallHierarchyProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​CallHierarchyRegistrationOptions> callHierarchyProvider)
        The server provides Call Hierarchy support.

        Since 3.16.0

      • setCallHierarchyProvider

        public void setCallHierarchyProvider​(java.lang.Boolean callHierarchyProvider)

      • getSelectionRangeProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​SelectionRangeRegistrationOptions> getSelectionRangeProvider()
        The server provides selection range support.

        Since 3.15.0

      • setSelectionRangeProvider

        public void setSelectionRangeProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​SelectionRangeRegistrationOptions> selectionRangeProvider)
        The server provides selection range support.

        Since 3.15.0

      • setSelectionRangeProvider

        public void setSelectionRangeProvider​(java.lang.Boolean selectionRangeProvider)

      • getLinkedEditingRangeProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​LinkedEditingRangeRegistrationOptions> getLinkedEditingRangeProvider()
        The server provides linked editing range support.

        Since 3.16.0

      • setLinkedEditingRangeProvider

        public void setLinkedEditingRangeProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​LinkedEditingRangeRegistrationOptions> linkedEditingRangeProvider)
        The server provides linked editing range support.

        Since 3.16.0

      • setLinkedEditingRangeProvider

        public void setLinkedEditingRangeProvider​(java.lang.Boolean linkedEditingRangeProvider)

      • setSemanticTokensProvider

        public void setSemanticTokensProvider​(SemanticTokensWithRegistrationOptions semanticTokensProvider)
        The server provides semantic tokens support.

        Since 3.16.0

      • getMonikerProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​MonikerRegistrationOptions> getMonikerProvider()
        Whether server provides moniker support.

        Since 3.16.0

      • setMonikerProvider

        public void setMonikerProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​MonikerRegistrationOptions> monikerProvider)
        Whether server provides moniker support.

        Since 3.16.0

      • setMonikerProvider

        public void setMonikerProvider​(java.lang.Boolean monikerProvider)

      • getInlayHintProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​InlayHintRegistrationOptions> getInlayHintProvider()
        The server provides inlay hints.

        Since 3.17.0

      • setInlayHintProvider

        public void setInlayHintProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​InlayHintRegistrationOptions> inlayHintProvider)
        The server provides inlay hints.

        Since 3.17.0

      • setInlayHintProvider

        public void setInlayHintProvider​(java.lang.Boolean inlayHintProvider)

      • getInlineValueProvider

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​InlineValueRegistrationOptions> getInlineValueProvider()
        The server provides inline values.

        Since 3.17.0

      • setInlineValueProvider

        public void setInlineValueProvider​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Boolean,​InlineValueRegistrationOptions> inlineValueProvider)
        The server provides inline values.

        Since 3.17.0

      • setInlineValueProvider

        public void setInlineValueProvider​(java.lang.Boolean inlineValueProvider)

      • getDiagnosticProvider

        public DiagnosticRegistrationOptions getDiagnosticProvider()
        The server has support for pull model diagnostics.

        Since 3.17.0

      • setDiagnosticProvider

        public void setDiagnosticProvider​(DiagnosticRegistrationOptions diagnosticProvider)
        The server has support for pull model diagnostics.

        Since 3.17.0

      • getExperimental

        public java.lang.Object getExperimental()
        Experimental server capabilities.

      • setExperimental

        public void setExperimental​(java.lang.Object experimental)
        Experimental server 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