Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class CompletionItemCapabilities

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

The client supports the following CompletionItem specific capabilities.

Field Summary

Modifier and TypeField 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<String>
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 CompletionItem#insertTextMode property on a completion item to override the whitespace handling mode as defined by the client.

private Boolean
labelDetailsSupport

The client has support for completion item label details (see also CompletionItemLabelDetails).

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.

Constructor Summary

AccessConstructor and Description
public
public
CompletionItemCapabilities(final Boolean snippetSupport)

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
getCommitCharactersSupport()

Client supports commit characters on a completion item.

public Boolean
getDeprecatedSupport()

Client supports the deprecated property on a completion item.

public List<String>
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 CompletionItem#insertTextMode property on a completion item to override the whitespace handling mode as defined by the client.

public Boolean
getLabelDetailsSupport()

The client has support for completion item label details (see also CompletionItemLabelDetails).

public Boolean
getPreselectSupport()

Client supports the preselect property on a completion item.

public CompletionItemResolveSupportCapabilities
getResolveSupport()

Indicates which properties a client can resolve lazily on a completion item.

public Boolean
getSnippetSupport()

Client supports snippets as insert text.

public CompletionItemTagSupportCapabilities
getTagSupport()

Client supports the tag property on a completion item.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

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 CompletionItem#insertTextMode property on a completion item to override the whitespace handling mode as defined by the client.

public void
setLabelDetailsSupport(final Boolean labelDetailsSupport)

The client has support for completion item label details (see also CompletionItemLabelDetails).

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
setSnippetSupport(final Boolean snippetSupport)

Client supports snippets as insert text.

public void
setTagSupport(final CompletionItemTagSupportCapabilities tagSupport)

Client supports the tag property on a completion item.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

commitCharactersSupportback to summary
private Boolean commitCharactersSupport

Client supports commit characters on a completion item.

Since 3.2.0

deprecatedSupportback to summary
private Boolean deprecatedSupport

Client supports the deprecated property on a completion item.

Since 3.8.0

documentationFormatback 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 MarkupKind for allowed values.

Since 3.3.0

insertReplaceSupportback 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

insertTextModeSupportback to summary
private 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

labelDetailsSupportback to summary
private Boolean labelDetailsSupport

The client has support for completion item label details (see also CompletionItemLabelDetails).

Since 3.17.0

preselectSupportback to summary
private Boolean preselectSupport

Client supports the preselect property on a completion item.

Since 3.9.0

resolveSupportback 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 CompletionItem#documentation and CompletionItem#detail could be resolved lazily.

Since 3.16.0

snippetSupportback 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.

tagSupportback 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

Constructor Detail

CompletionItemCapabilitiesback to summary
public CompletionItemCapabilities()
CompletionItemCapabilitiesback to summary
public CompletionItemCapabilities(final Boolean snippetSupport)

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
getCommitCharactersSupportback to summary
public Boolean getCommitCharactersSupport()

Client supports commit characters on a completion item.

Since 3.2.0

getDeprecatedSupportback to summary
public Boolean getDeprecatedSupport()

Client supports the deprecated property on a completion item.

Since 3.8.0

getDocumentationFormatback to summary
public List<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

getInsertReplaceSupportback 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

getInsertTextModeSupportback to summary
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

getLabelDetailsSupportback to summary
public Boolean getLabelDetailsSupport()

The client has support for completion item label details (see also CompletionItemLabelDetails).

Since 3.17.0

getPreselectSupportback to summary
public Boolean getPreselectSupport()

Client supports the preselect property on a completion item.

Since 3.9.0

getResolveSupportback 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 CompletionItem#documentation and CompletionItem#detail could be resolved lazily.

Since 3.16.0

getSnippetSupportback 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.

getTagSupportback 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

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
setCommitCharactersSupportback to summary
public void setCommitCharactersSupport(final Boolean commitCharactersSupport)

Client supports commit characters on a completion item.

Since 3.2.0

setDeprecatedSupportback to summary
public void setDeprecatedSupport(final Boolean deprecatedSupport)

Client supports the deprecated property on a completion item.

Since 3.8.0

setDocumentationFormatback 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 MarkupKind for allowed values.

Since 3.3.0

setInsertReplaceSupportback 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

setInsertTextModeSupportback to summary
public void setInsertTextModeSupport(final 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

setLabelDetailsSupportback to summary
public void setLabelDetailsSupport(final Boolean labelDetailsSupport)

The client has support for completion item label details (see also CompletionItemLabelDetails).

Since 3.17.0

setPreselectSupportback to summary
public void setPreselectSupport(final Boolean preselectSupport)

Client supports the preselect property on a completion item.

Since 3.9.0

setResolveSupportback 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 CompletionItem#documentation and CompletionItem#detail could be resolved lazily.

Since 3.16.0

setSnippetSupportback 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.

setTagSupportback 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

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