Package org.eclipse.lsp4j

Class CompletionItemCapabilities

  • public class CompletionItemCapabilities
extends java.lang.Object
    The client supports the following CompletionItem specific capabilities.

    • Constructor Detail

      • CompletionItemCapabilities

        public CompletionItemCapabilities()

      • CompletionItemCapabilities

        public CompletionItemCapabilities​(java.lang.Boolean snippetSupport)

    • Method Detail

      • getSnippetSupport

        public java.lang.Boolean getSnippetSupport()
        Client supports snippets as insert text.

        A snippet can define tab stops and placeholders with `$1`, `$2` and `${3:foo}`. `$0` defines the final tab stop, it defaults to the end of the snippet. Placeholders with equal identifiers are linked, that is typing in one will update others too.

      • setSnippetSupport

        public void setSnippetSupport​(java.lang.Boolean snippetSupport)
        Client supports snippets as insert text.

        A snippet can define tab stops and placeholders with `$1`, `$2` and `${3:foo}`. `$0` defines the final tab stop, it defaults to the end of the snippet. Placeholders with equal identifiers are linked, that is typing in one will update others too.

      • getCommitCharactersSupport

        public java.lang.Boolean getCommitCharactersSupport()
        Client supports commit characters on a completion item.

        Since 3.2.0

      • setCommitCharactersSupport

        public void setCommitCharactersSupport​(java.lang.Boolean commitCharactersSupport)
        Client supports commit characters on a completion item.

        Since 3.2.0

      • getDocumentationFormat

        public java.util.List<java.lang.String> getDocumentationFormat()
        Client supports the following content formats for the documentation property. The order describes the preferred format of the client.

        See MarkupKind for allowed values.

        Since 3.3.0

      • setDocumentationFormat

        public void setDocumentationFormat​(java.util.List<java.lang.String> documentationFormat)
        Client supports the following content formats for the documentation property. The order describes the preferred format of the client.

        See MarkupKind for allowed values.

        Since 3.3.0

      • getDeprecatedSupport

        public java.lang.Boolean getDeprecatedSupport()
        Client supports the deprecated property on a completion item.

        Since 3.8.0

      • setDeprecatedSupport

        public void setDeprecatedSupport​(java.lang.Boolean deprecatedSupport)
        Client supports the deprecated property on a completion item.

        Since 3.8.0

      • getPreselectSupport

        public java.lang.Boolean getPreselectSupport()
        Client supports the preselect property on a completion item.

        Since 3.9.0

      • setPreselectSupport

        public void setPreselectSupport​(java.lang.Boolean preselectSupport)
        Client supports the preselect property on a completion item.

        Since 3.9.0

      • getTagSupport

        public CompletionItemTagSupportCapabilities getTagSupport()
        Client supports the tag property on a completion item. Clients supporting tags have to handle unknown tags gracefully. Clients especially need to preserve unknown tags when sending a completion item back to the server in a resolve call.

        Since 3.15.0

      • setTagSupport

        public void setTagSupport​(CompletionItemTagSupportCapabilities tagSupport)
        Client supports the tag property on a completion item. Clients supporting tags have to handle unknown tags gracefully. Clients especially need to preserve unknown tags when sending a completion item back to the server in a resolve call.

        Since 3.15.0

      • getInsertReplaceSupport

        public java.lang.Boolean getInsertReplaceSupport()
        Client support insert replace edit to control different behavior if a completion item is inserted in the text or should replace text.

        Since 3.16.0

      • setInsertReplaceSupport

        public void setInsertReplaceSupport​(java.lang.Boolean insertReplaceSupport)
        Client support insert replace edit to control different behavior if a completion item is inserted in the text or should replace text.

        Since 3.16.0

      • getResolveSupport

        public CompletionItemResolveSupportCapabilities getResolveSupport()
        Indicates which properties a client can resolve lazily on a completion item. Before version 3.16.0 only the predefined properties CompletionItem.documentation and CompletionItem.detail could be resolved lazily.

        Since 3.16.0

      • setResolveSupport

        public void setResolveSupport​(CompletionItemResolveSupportCapabilities resolveSupport)
        Indicates which properties a client can resolve lazily on a completion item. Before version 3.16.0 only the predefined properties CompletionItem.documentation and CompletionItem.detail could be resolved lazily.

        Since 3.16.0

      • getInsertTextModeSupport

        public CompletionItemInsertTextModeSupportCapabilities getInsertTextModeSupport()
        The client supports the CompletionItem.insertTextMode property on a completion item to override the whitespace handling mode as defined by the client.

        Since 3.16.0

      • setInsertTextModeSupport

        public void setInsertTextModeSupport​(CompletionItemInsertTextModeSupportCapabilities insertTextModeSupport)
        The client supports the CompletionItem.insertTextMode property on a completion item to override the whitespace handling mode as defined by the client.

        Since 3.16.0

      • getLabelDetailsSupport

        public java.lang.Boolean getLabelDetailsSupport()
        The client has support for completion item label details (see also CompletionItemLabelDetails).

        Since 3.17.0

      • setLabelDetailsSupport

        public void setLabelDetailsSupport​(java.lang.Boolean labelDetailsSupport)
        The client has support for completion item label details (see also CompletionItemLabelDetails).

        Since 3.17.0

      • 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