CompletionItem specific capabilities.
| Modifier and Type | Field and Description |
|---|---|
| private Boolean | commitCharactersSupport
Client supports commit characters on a completion item. |
| private Boolean | deprecatedSupport
Client supports the deprecated property on a completion item. |
| private List | documentationFormat
Client supports the following content formats for the documentation property. |
| private Boolean | insertReplaceSupport
Client support insert replace edit to control different behavior if a completion item is inserted in the text or should replace text. |
| private CompletionItemInsertTextModeSupportCapabilities | insertTextModeSupport
The client supports the |
| private Boolean | labelDetailsSupport
The client has support for completion item label details (see also |
| private Boolean | preselectSupport
Client supports the preselect property on a completion item. |
| private CompletionItemResolveSupportCapabilities | resolveSupport
Indicates which properties a client can resolve lazily on a completion item. |
| private Boolean | snippetSupport
Client supports snippets as insert text. |
| private CompletionItemTagSupportCapabilities | tagSupport
Client supports the tag property on a completion item. |
| Access | Constructor and Description |
|---|---|
| public | |
| public |
| Modifier and Type | Method and Description |
|---|---|
| public boolean | equals(final Object obj)
Overrides java. Indicates whether some other object is "equal to" this one. |
| public Boolean | |
| public Boolean | |
| public List | getDocumentationFormat()
Client supports the following content formats for the documentation property. |
| public Boolean | getInsertReplaceSupport()
Client support insert replace edit to control different behavior if a completion item is inserted in the text or should replace text. |
| public CompletionItemInsertTextModeSupportCapabilities | getInsertTextModeSupport()
The client supports the |
| public Boolean | getLabelDetailsSupport()
The client has support for completion item label details (see also |
| public Boolean | |
| public CompletionItemResolveSupportCapabilities | |
| public Boolean | |
| public CompletionItemTagSupportCapabilities | |
| public int | |
| public void | setCommitCharactersSupport(final Boolean commitCharactersSupport)
Client supports commit characters on a completion item. |
| public void | setDeprecatedSupport(final Boolean deprecatedSupport)
Client supports the deprecated property on a completion item. |
| public void | setDocumentationFormat(final List<String> documentationFormat)
Client supports the following content formats for the documentation property. |
| public void | setInsertReplaceSupport(final Boolean insertReplaceSupport)
Client support insert replace edit to control different behavior if a completion item is inserted in the text or should replace text. |
| public void | setInsertTextModeSupport(final CompletionItemInsertTextModeSupportCapabilities insertTextModeSupport)
The client supports the |
| public void | setLabelDetailsSupport(final Boolean labelDetailsSupport)
The client has support for completion item label details (see also |
| public void | setPreselectSupport(final Boolean preselectSupport)
Client supports the preselect property on a completion item. |
| public void | setResolveSupport(final CompletionItemResolveSupportCapabilities resolveSupport)
Indicates which properties a client can resolve lazily on a completion item. |
| public void | |
| public void | setTagSupport(final CompletionItemTagSupportCapabilities tagSupport)
Client supports the tag property on a completion item. |
| public String |
| commitCharactersSupport | back to summary |
|---|---|
| private Boolean commitCharactersSupport Client supports commit characters on a completion item. Since 3.2.0 | |
| deprecatedSupport | back to summary |
|---|---|
| private Boolean deprecatedSupport Client supports the deprecated property on a completion item. Since 3.8.0 | |
| documentationFormat | back to summary |
|---|---|
| private List<String> documentationFormat Client supports the following content formats for the documentation property. The order describes the preferred format of the client.
See Since 3.3.0 | |
| insertReplaceSupport | back to summary |
|---|---|
| private 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 | |
| insertTextModeSupport | back to summary |
|---|---|
| private CompletionItemInsertTextModeSupportCapabilities insertTextModeSupport The client supports the Since 3.16.0 | |
| labelDetailsSupport | back to summary |
|---|---|
| private Boolean labelDetailsSupport The client has support for completion item label details (see also Since 3.17.0 | |
| preselectSupport | back to summary |
|---|---|
| private Boolean preselectSupport Client supports the preselect property on a completion item. Since 3.9.0 | |
| resolveSupport | back to summary |
|---|---|
| private CompletionItemResolveSupportCapabilities resolveSupport Indicates which properties a client can resolve lazily on a completion
item. Before version 3.16.0 only the predefined properties Since 3.16.0 | |
| snippetSupport | back to summary |
|---|---|
| private 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. | |
| tagSupport | back to summary |
|---|---|
| private 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 | |
| CompletionItemCapabilities | back to summary |
|---|---|
| public CompletionItemCapabilities() | |
| CompletionItemCapabilities | back to summary |
|---|---|
| public CompletionItemCapabilities(final Boolean snippetSupport) | |
| equals | back to summary |
|---|---|
| public boolean equals(final Object obj) Overrides java. Doc from java. Indicates whether some other object is "equal to" this one.
The
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.
| |
| getCommitCharactersSupport | back to summary |
|---|---|
| public Boolean getCommitCharactersSupport() Client supports commit characters on a completion item. Since 3.2.0 | |
| getDeprecatedSupport | back to summary |
|---|---|
| public Boolean getDeprecatedSupport() Client supports the deprecated property on a completion item. Since 3.8.0 | |
| getDocumentationFormat | back to summary |
|---|---|
| public List Client supports the following content formats for the documentation property. The order describes the preferred format of the client.
See Since 3.3.0 | |
| getInsertReplaceSupport | back to summary |
|---|---|
| public 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 | |
| getInsertTextModeSupport | back to summary |
|---|---|
| public CompletionItemInsertTextModeSupportCapabilities getInsertTextModeSupport() The client supports the Since 3.16.0 | |
| getLabelDetailsSupport | back to summary |
|---|---|
| public Boolean getLabelDetailsSupport() The client has support for completion item label details (see also Since 3.17.0 | |
| getPreselectSupport | back to summary |
|---|---|
| public Boolean getPreselectSupport() Client supports the preselect property on a completion item. Since 3.9.0 | |
| getResolveSupport | back to summary |
|---|---|
| public CompletionItemResolveSupportCapabilities getResolveSupport() Indicates which properties a client can resolve lazily on a completion
item. Before version 3.16.0 only the predefined properties Since 3.16.0 | |
| getSnippetSupport | back to summary |
|---|---|
| public 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. | |
| getTagSupport | back to summary |
|---|---|
| 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 | |
| hashCode | back to summary |
|---|---|
| public int hashCode() Overrides java. Doc from java. Returns a hash code value for this object. This method is
supported for the benefit of hash tables such as those provided by
The general contract of
| |
| setCommitCharactersSupport | back to summary |
|---|---|
| public void setCommitCharactersSupport(final Boolean commitCharactersSupport) Client supports commit characters on a completion item. Since 3.2.0 | |
| setDeprecatedSupport | back to summary |
|---|---|
| public void setDeprecatedSupport(final Boolean deprecatedSupport) Client supports the deprecated property on a completion item. Since 3.8.0 | |
| setDocumentationFormat | back to summary |
|---|---|
| public void setDocumentationFormat(final List<String> documentationFormat) Client supports the following content formats for the documentation property. The order describes the preferred format of the client.
See Since 3.3.0 | |
| setInsertReplaceSupport | back to summary |
|---|---|
| public void setInsertReplaceSupport(final 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 | |
| setInsertTextModeSupport | back to summary |
|---|---|
| public void setInsertTextModeSupport(final CompletionItemInsertTextModeSupportCapabilities insertTextModeSupport) The client supports the Since 3.16.0 | |
| setLabelDetailsSupport | back to summary |
|---|---|
| public void setLabelDetailsSupport(final Boolean labelDetailsSupport) The client has support for completion item label details (see also Since 3.17.0 | |
| setPreselectSupport | back to summary |
|---|---|
| public void setPreselectSupport(final Boolean preselectSupport) Client supports the preselect property on a completion item. Since 3.9.0 | |
| setResolveSupport | back to summary |
|---|---|
| public void setResolveSupport(final CompletionItemResolveSupportCapabilities resolveSupport) Indicates which properties a client can resolve lazily on a completion
item. Before version 3.16.0 only the predefined properties Since 3.16.0 | |
| setSnippetSupport | back to summary |
|---|---|
| public void setSnippetSupport(final 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. | |
| setTagSupport | back to summary |
|---|---|
| public void setTagSupport(final 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 | |
| toString | back to summary |
|---|---|
| public String toString() Overrides java. Doc from java. Returns a string representation of the object.
Satisfying this method's contract implies a non-
| |