Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.CompletionItem

Modifier and Type	Field and Description
private List<TextEdit>	additionalTextEdits An optional array of additional text edits that are applied when selecting this completion.
private Command	command An optional command that is executed after inserting this completion Note that additional modifications to the current document should be described with the `additionalTextEdits` property.
private List<String>	commitCharacters An optional set of characters that when pressed while this completion is active will accept it first and then type that character Note that all commit characters should have `length=1` and that superfluous characters will be ignored.
private Object	data A data entry field that is preserved on a completion item between a completion and a completion resolve request.
private Boolean	deprecated Deprecated Use `tags` instead if supported. Indicates if this item is deprecated.
private String	detail A human-readable string with additional information about this item, like type or symbol information.
private Either<String, MarkupContent>	documentation A human-readable string that represents a doc-comment.
private String	filterText A string that should be used when filtering a set of completion items.
private String	insertText A string that should be inserted a document when selecting this completion.
private InsertTextFormat	insertTextFormat The format of the insert text.
private InsertTextMode	insertTextMode How whitespace and indentation is handled during completion item insertion.
private CompletionItemKind	kind The kind of this completion item.
private String	label The label of this completion item.
private CompletionItemLabelDetails	labelDetails Additional details for the label Since 3.17.0
private Boolean	preselect Select this item when showing.
private String	sortText A string that should be used when comparing this item with other items.
private List<CompletionItemTag>	tags Tags for this completion item.
private Either<TextEdit, InsertReplaceEdit>	textEdit An edit which is applied to a document when selecting this completion.
private String	textEditText The edit text used if the completion item is part of a CompletionList and CompletionList defines an item default for the text edit range.

Access	Constructor and Description
public	CompletionItem()
public	CompletionItem(final String label)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public List<TextEdit>	getAdditionalTextEdits() An optional array of additional text edits that are applied when selecting this completion.
public Command	getCommand() An optional command that is executed after inserting this completion Note that additional modifications to the current document should be described with the `additionalTextEdits` property.
public List<String>	getCommitCharacters() An optional set of characters that when pressed while this completion is active will accept it first and then type that character Note that all commit characters should have `length=1` and that superfluous characters will be ignored.
public Object	getData() A data entry field that is preserved on a completion item between a completion and a completion resolve request.
public Boolean	getDeprecated() Deprecated Use `tags` instead if supported. Indicates if this item is deprecated.
public String	getDetail() A human-readable string with additional information about this item, like type or symbol information.
public Either<String, MarkupContent>	getDocumentation() A human-readable string that represents a doc-comment.
public String	getFilterText() A string that should be used when filtering a set of completion items.
public String	getInsertText() A string that should be inserted a document when selecting this completion.
public InsertTextFormat	getInsertTextFormat() The format of the insert text.
public InsertTextMode	getInsertTextMode() How whitespace and indentation is handled during completion item insertion.
public CompletionItemKind	getKind() The kind of this completion item.
public String	getLabel() The label of this completion item.
public CompletionItemLabelDetails	getLabelDetails() Additional details for the label Since 3.17.0
public Boolean	getPreselect() Select this item when showing.
public String	getSortText() A string that should be used when comparing this item with other items.
public List<CompletionItemTag>	getTags() Tags for this completion item.
public Either<TextEdit, InsertReplaceEdit>	getTextEdit() An edit which is applied to a document when selecting this completion.
public String	getTextEditText() The edit text used if the completion item is part of a CompletionList and CompletionList defines an item default for the text edit range.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setAdditionalTextEdits(final List<TextEdit> additionalTextEdits) An optional array of additional text edits that are applied when selecting this completion.
public void	setCommand(final Command command) An optional command that is executed after inserting this completion Note that additional modifications to the current document should be described with the `additionalTextEdits` property.
public void	setCommitCharacters(final List<String> commitCharacters) An optional set of characters that when pressed while this completion is active will accept it first and then type that character Note that all commit characters should have `length=1` and that superfluous characters will be ignored.
public void	setData(final Object data) A data entry field that is preserved on a completion item between a completion and a completion resolve request.
public void	setDeprecated(final Boolean deprecated) Deprecated Use `tags` instead if supported. Indicates if this item is deprecated.
public void	setDetail(final String detail) A human-readable string with additional information about this item, like type or symbol information.
public void	setDocumentation(final Either<String, MarkupContent> documentation) A human-readable string that represents a doc-comment.
public void	setDocumentation(final String documentation)
public void	setDocumentation(final MarkupContent documentation)
public void	setFilterText(final String filterText) A string that should be used when filtering a set of completion items.
public void	setInsertText(final String insertText) A string that should be inserted a document when selecting this completion.
public void	setInsertTextFormat(final InsertTextFormat insertTextFormat) The format of the insert text.
public void	setInsertTextMode(final InsertTextMode insertTextMode) How whitespace and indentation is handled during completion item insertion.
public void	setKind(final CompletionItemKind kind) The kind of this completion item.
public void	setLabel(final String label) The label of this completion item.
public void	setLabelDetails(final CompletionItemLabelDetails labelDetails) Additional details for the label Since 3.17.0
public void	setPreselect(final Boolean preselect) Select this item when showing.
public void	setSortText(final String sortText) A string that should be used when comparing this item with other items.
public void	setTags(final List<CompletionItemTag> tags) Tags for this completion item.
public void	setTextEdit(final Either<TextEdit, InsertReplaceEdit> textEdit) An edit which is applied to a document when selecting this completion.
public void	setTextEditText(final String textEditText) The edit text used if the completion item is part of a CompletionList and CompletionList defines an item default for the text edit range.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

additionalTextEdits	back to summary
private List<TextEdit> additionalTextEdits An optional array of additional text edits that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main edit nor with themselves. Additional text edits should be used to change text unrelated to the current cursor position (for example adding an import statement at the top of the file if the completion item will insert an unqualified type).

additionalTextEdits

back to summary

private List<TextEdit> additionalTextEdits

An optional array of additional text edits that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main edit nor with themselves.

Additional text edits should be used to change text unrelated to the current cursor position (for example adding an import statement at the top of the file if the completion item will insert an unqualified type).

command	back to summary
private Command command An optional command that is executed after inserting this completion Note that additional modifications to the current document should be described with the `additionalTextEdits` property.

commitCharacters back to summary

commitCharacters	back to summary
private List<String> commitCharacters An optional set of characters that when pressed while this completion is active will accept it first and then type that character Note that all commit characters should have `length=1` and that superfluous characters will be ignored. Since 3.2.0

private List<String> commitCharacters

An optional set of characters that when pressed while this completion is active will accept it first and then type that character

Note

that all commit characters should have length=1 and that superfluous characters will be ignored.

Since 3.2.0

data	back to summary
private Object data A data entry field that is preserved on a completion item between a completion and a completion resolve request. Annotations @JsonAdapter:Factory

deprecated back to summary

deprecated	back to summary
private Boolean deprecated Deprecated Use `tags` instead if supported. Indicates if this item is deprecated. Since 3.8.0 Annotations @Deprecated

private Boolean deprecated

Deprecated

Use tags instead if supported.

Indicates if this item is deprecated.

Since 3.8.0

Annotations

@Deprecated

detail	back to summary
private String detail A human-readable string with additional information about this item, like type or symbol information.

documentation	back to summary
private Either<String, MarkupContent> documentation A human-readable string that represents a doc-comment.

filterText	back to summary
private String filterText A string that should be used when filtering a set of completion items. When omitted or empty, the `label` is used as the filter text for this item.

insertText	back to summary
private String insertText A string that should be inserted a document when selecting this completion. When omitted or empty, the `label` is used as the insert text for this item.

insertTextFormat back to summary

insertTextFormat	back to summary
private InsertTextFormat insertTextFormat The format of the insert text. The format applies to both the `insertText` property and the `newText` property of a provided `textEdit`. If omitted, defaults to `InsertTextFormat#PlainText`. Please note that this doesn't apply to `additionalTextEdits`.

private InsertTextFormat insertTextFormat

The format of the insert text. The format applies to both the insertText property and the newText property of a provided textEdit. If omitted, defaults to InsertTextFormat#PlainText.

Please note that this doesn't apply to additionalTextEdits.

insertTextMode back to summary

insertTextMode	back to summary
private InsertTextMode insertTextMode How whitespace and indentation is handled during completion item insertion. If not provided, the client's default value depends on the `CompletionCapabilities#insertTextMode` client capability. Since 3.16.0

private InsertTextMode insertTextMode

How whitespace and indentation is handled during completion item insertion. If not provided, the client's default value depends on the CompletionCapabilities#insertTextMode client capability.

Since 3.16.0

kind	back to summary
private CompletionItemKind kind The kind of this completion item. Based of the kind an icon is chosen by the editor.

label	back to summary
private String label The label of this completion item. By default also the text that is inserted when selecting this completion. If label details are provided, the label itself should be an unqualified name of the completion item. Annotations @NonNull

label

back to summary

private String label

The label of this completion item. By default also the text that is inserted when selecting this completion.

If label details are provided, the label itself should be an unqualified name of the completion item.

Annotations

@NonNull

labelDetails	back to summary
private CompletionItemLabelDetails labelDetails Additional details for the label Since 3.17.0

labelDetails

back to summary

private CompletionItemLabelDetails labelDetails

Additional details for the label

Since 3.17.0

preselect	back to summary
private Boolean preselect Select this item when showing. Note that only one completion item can be selected and that the tool / client decides which item that is. The rule is that the first item of those that match best is selected. Since 3.9.0

preselect

back to summary

private Boolean preselect

Select this item when showing.

Note

that only one completion item can be selected and that the tool / client decides which item that is. The rule is that the first item of those that match best is selected.

Since 3.9.0

sortText	back to summary
private String sortText A string that should be used when comparing this item with other items. When omitted or empty, the `label` is used as the sort text for this item.

tags	back to summary
private List<CompletionItemTag> tags Tags for this completion item. Since 3.15.0

textEdit	back to summary
private Either<TextEdit, InsertReplaceEdit> textEdit An edit which is applied to a document when selecting this completion. When an edit is provided the value of `insertText` is ignored. Note The range of the edit must be a single line range and it must contain the position at which completion has been requested. Most editors support two different operations when accepting a completion item. One is to insert a completion text and the other is to replace an existing text with a completion text. Since this can usually not be predetermined by a server it can report both ranges. Clients need to signal support for `InsertReplaceEdit`s via the `CompletionItemCapabilities#insertReplaceSupport` client capability property. Note 1: The text edit's range as well as both ranges from an insert replace edit must be a [single line] and they must contain the position at which completion has been requested. Note 2: If an `InsertReplaceEdit` is returned the edit's insert range must be a prefix of the edit's replace range, that means it must be contained and starting at the same position. Since 3.16.0 additional type `InsertReplaceEdit` Annotations @JsonAdapter:CompletionItemTextEditTypeAdapter

textEditText	back to summary
private String textEditText The edit text used if the completion item is part of a CompletionList and CompletionList defines an item default for the text edit range. Clients will only honor this property if they opt into completion list item defaults using the capability `CompletionListCapabilities#itemDefaults`. If not provided and a list's default range is provided the label property is used as a text. Since 3.17.0

Constructor Detail

CompletionItem	back to summary
public CompletionItem()

CompletionItem	back to summary
public CompletionItem(final String label)

Method Detail

equals back to summary

equals	back 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

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

getAdditionalTextEdits	back to summary
public List<TextEdit> getAdditionalTextEdits() An optional array of additional text edits that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main edit nor with themselves. Additional text edits should be used to change text unrelated to the current cursor position (for example adding an import statement at the top of the file if the completion item will insert an unqualified type).

getAdditionalTextEdits

back to summary

public List<TextEdit> getAdditionalTextEdits()

An optional array of additional text edits that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main edit nor with themselves.

getCommand	back to summary
public Command getCommand() An optional command that is executed after inserting this completion Note that additional modifications to the current document should be described with the `additionalTextEdits` property.

getCommitCharacters back to summary

getCommitCharacters	back to summary
public List<String> getCommitCharacters() An optional set of characters that when pressed while this completion is active will accept it first and then type that character Note that all commit characters should have `length=1` and that superfluous characters will be ignored. Since 3.2.0

public List<String> getCommitCharacters()

An optional set of characters that when pressed while this completion is active will accept it first and then type that character

Note

that all commit characters should have length=1 and that superfluous characters will be ignored.

Since 3.2.0

getData	back to summary
public Object getData() A data entry field that is preserved on a completion item between a completion and a completion resolve request.

getDeprecated back to summary

getDeprecated	back to summary
public Boolean getDeprecated() Deprecated Use `tags` instead if supported. Indicates if this item is deprecated. Since 3.8.0 Annotations @Deprecated

public Boolean getDeprecated()

Deprecated

Use tags instead if supported.

Indicates if this item is deprecated.

Since 3.8.0

Annotations

@Deprecated

getDetail	back to summary
public String getDetail() A human-readable string with additional information about this item, like type or symbol information.

getDocumentation	back to summary
public Either<String, MarkupContent> getDocumentation() A human-readable string that represents a doc-comment.

getFilterText	back to summary
public String getFilterText() A string that should be used when filtering a set of completion items. When omitted or empty, the `label` is used as the filter text for this item.

getInsertText	back to summary
public String getInsertText() A string that should be inserted a document when selecting this completion. When omitted or empty, the `label` is used as the insert text for this item.

getInsertTextFormat back to summary

getInsertTextFormat	back to summary
public InsertTextFormat getInsertTextFormat() The format of the insert text. The format applies to both the `insertText` property and the `newText` property of a provided `textEdit`. If omitted, defaults to `InsertTextFormat#PlainText`. Please note that this doesn't apply to `additionalTextEdits`.

public InsertTextFormat getInsertTextFormat()

The format of the insert text. The format applies to both the insertText property and the newText property of a provided textEdit. If omitted, defaults to InsertTextFormat#PlainText.

Please note that this doesn't apply to additionalTextEdits.

getInsertTextMode back to summary

getInsertTextMode	back to summary
public InsertTextMode getInsertTextMode() How whitespace and indentation is handled during completion item insertion. If not provided, the client's default value depends on the `CompletionCapabilities#insertTextMode` client capability. Since 3.16.0

public InsertTextMode getInsertTextMode()

How whitespace and indentation is handled during completion item insertion. If not provided, the client's default value depends on the CompletionCapabilities#insertTextMode client capability.

Since 3.16.0

getKind	back to summary
public CompletionItemKind getKind() The kind of this completion item. Based of the kind an icon is chosen by the editor.

getLabel	back to summary
public String getLabel() The label of this completion item. By default also the text that is inserted when selecting this completion. If label details are provided, the label itself should be an unqualified name of the completion item. Annotations @NonNull

getLabel

back to summary

public String getLabel()

The label of this completion item. By default also the text that is inserted when selecting this completion.

If label details are provided, the label itself should be an unqualified name of the completion item.

Annotations

@NonNull

getLabelDetails	back to summary
public CompletionItemLabelDetails getLabelDetails() Additional details for the label Since 3.17.0

getLabelDetails

back to summary

public CompletionItemLabelDetails getLabelDetails()

Additional details for the label

Since 3.17.0

getPreselect	back to summary
public Boolean getPreselect() Select this item when showing. Note that only one completion item can be selected and that the tool / client decides which item that is. The rule is that the first item of those that match best is selected. Since 3.9.0

getPreselect

back to summary

public Boolean getPreselect()

Select this item when showing.

Note

that only one completion item can be selected and that the tool / client decides which item that is. The rule is that the first item of those that match best is selected.

Since 3.9.0

getSortText	back to summary
public String getSortText() A string that should be used when comparing this item with other items. When omitted or empty, the `label` is used as the sort text for this item.

getTags	back to summary
public List<CompletionItemTag> getTags() Tags for this completion item. Since 3.15.0

getTags

back to summary

public List<CompletionItemTag> getTags()

Tags for this completion item.

Since 3.15.0

getTextEdit back to summary

getTextEdit	back to summary
public Either<TextEdit, InsertReplaceEdit> getTextEdit() An edit which is applied to a document when selecting this completion. When an edit is provided the value of `insertText` is ignored. Note The range of the edit must be a single line range and it must contain the position at which completion has been requested. Most editors support two different operations when accepting a completion item. One is to insert a completion text and the other is to replace an existing text with a completion text. Since this can usually not be predetermined by a server it can report both ranges. Clients need to signal support for `InsertReplaceEdit`s via the `CompletionItemCapabilities#insertReplaceSupport` client capability property. Note 1: The text edit's range as well as both ranges from an insert replace edit must be a [single line] and they must contain the position at which completion has been requested. Note 2: If an `InsertReplaceEdit` is returned the edit's insert range must be a prefix of the edit's replace range, that means it must be contained and starting at the same position. Since 3.16.0 additional type `InsertReplaceEdit`

public Either<TextEdit, InsertReplaceEdit> getTextEdit()

An edit which is applied to a document when selecting this completion. When an edit is provided the value of insertText is ignored.

Note

The range of the edit must be a single line range and it must contain the position at which completion has been requested.

Note 1: The text edit's range as well as both ranges from an insert replace edit must be a [single line] and they must contain the position at which completion has been requested.

Note 2: If an InsertReplaceEdit is returned the edit's insert range must be a prefix of the edit's replace range, that means it must be contained and starting at the same position.

Since 3.16.0 additional type InsertReplaceEdit

getTextEditText back to summary

getTextEditText	back to summary
public String getTextEditText() The edit text used if the completion item is part of a CompletionList and CompletionList defines an item default for the text edit range. Clients will only honor this property if they opt into completion list item defaults using the capability `CompletionListCapabilities#itemDefaults`. If not provided and a list's default range is provided the label property is used as a text. Since 3.17.0

public String getTextEditText()

The edit text used if the completion item is part of a CompletionList and CompletionList defines an item default for the text edit range.

Clients will only honor this property if they opt into completion list item defaults using the capability CompletionListCapabilities#itemDefaults.

If not provided and a list's default range is provided the label property is used as a text.

Since 3.17.0

hashCode back to summary

hashCode	back 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

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

setAdditionalTextEdits	back to summary
public void setAdditionalTextEdits(final List<TextEdit> additionalTextEdits) An optional array of additional text edits that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main edit nor with themselves. Additional text edits should be used to change text unrelated to the current cursor position (for example adding an import statement at the top of the file if the completion item will insert an unqualified type).

setAdditionalTextEdits

back to summary

public void setAdditionalTextEdits(final List<TextEdit> additionalTextEdits)

An optional array of additional text edits that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main edit nor with themselves.

setCommand	back to summary
public void setCommand(final Command command) An optional command that is executed after inserting this completion Note that additional modifications to the current document should be described with the `additionalTextEdits` property.

setCommitCharacters back to summary

setCommitCharacters	back to summary
public void setCommitCharacters(final List<String> commitCharacters) An optional set of characters that when pressed while this completion is active will accept it first and then type that character Note that all commit characters should have `length=1` and that superfluous characters will be ignored. Since 3.2.0

public void setCommitCharacters(final List<String> commitCharacters)

An optional set of characters that when pressed while this completion is active will accept it first and then type that character

Note

that all commit characters should have length=1 and that superfluous characters will be ignored.

Since 3.2.0

setData	back to summary
public void setData(final Object data) A data entry field that is preserved on a completion item between a completion and a completion resolve request.

setDeprecated back to summary

setDeprecated	back to summary
public void setDeprecated(final Boolean deprecated) Deprecated Use `tags` instead if supported. Indicates if this item is deprecated. Since 3.8.0 Annotations @Deprecated

public void setDeprecated(final Boolean deprecated)

Deprecated

Use tags instead if supported.

Indicates if this item is deprecated.

Since 3.8.0

Annotations

@Deprecated

setDetail	back to summary
public void setDetail(final String detail) A human-readable string with additional information about this item, like type or symbol information.

setDocumentation	back to summary
public void setDocumentation(final Either<String, MarkupContent> documentation) A human-readable string that represents a doc-comment.

setDocumentation	back to summary
public void setDocumentation(final String documentation)

setDocumentation	back to summary
public void setDocumentation(final MarkupContent documentation)

setFilterText	back to summary
public void setFilterText(final String filterText) A string that should be used when filtering a set of completion items. When omitted or empty, the `label` is used as the filter text for this item.

setInsertText	back to summary
public void setInsertText(final String insertText) A string that should be inserted a document when selecting this completion. When omitted or empty, the `label` is used as the insert text for this item.

setInsertTextFormat back to summary

public void setInsertTextFormat(final InsertTextFormat insertTextFormat)

The format of the insert text. The format applies to both the insertText property and the newText property of a provided textEdit. If omitted, defaults to InsertTextFormat#PlainText.

Please note that this doesn't apply to additionalTextEdits.

setInsertTextMode back to summary

public void setInsertTextMode(final InsertTextMode insertTextMode)

How whitespace and indentation is handled during completion item insertion. If not provided, the client's default value depends on the CompletionCapabilities#insertTextMode client capability.

Since 3.16.0

setKind	back to summary
public void setKind(final CompletionItemKind kind) The kind of this completion item. Based of the kind an icon is chosen by the editor.

setLabel

back to summary

public void setLabel(final String label)

The label of this completion item. By default also the text that is inserted when selecting this completion.

If label details are provided, the label itself should be an unqualified name of the completion item.

setLabelDetails

back to summary

public void setLabelDetails(final CompletionItemLabelDetails labelDetails)

Additional details for the label

Since 3.17.0

setPreselect

back to summary

public void setPreselect(final Boolean preselect)

Select this item when showing.

Note

that only one completion item can be selected and that the tool / client decides which item that is. The rule is that the first item of those that match best is selected.

Since 3.9.0

setSortText	back to summary
public void setSortText(final String sortText) A string that should be used when comparing this item with other items. When omitted or empty, the `label` is used as the sort text for this item.

setTags

back to summary

public void setTags(final List<CompletionItemTag> tags)

Tags for this completion item.

Since 3.15.0

setTextEdit back to summary

public void setTextEdit(final Either<TextEdit, InsertReplaceEdit> textEdit)

An edit which is applied to a document when selecting this completion. When an edit is provided the value of insertText is ignored.

Note

The range of the edit must be a single line range and it must contain the position at which completion has been requested.

Note 1: The text edit's range as well as both ranges from an insert replace edit must be a [single line] and they must contain the position at which completion has been requested.

Note 2: If an InsertReplaceEdit is returned the edit's insert range must be a prefix of the edit's replace range, that means it must be contained and starting at the same position.

Since 3.16.0 additional type InsertReplaceEdit

setTextEditText back to summary

public void setTextEditText(final String textEditText)

The edit text used if the completion item is part of a CompletionList and CompletionList defines an item default for the text edit range.

Clients will only honor this property if they opt into completion list item defaults using the capability CompletionListCapabilities#itemDefaults.

If not provided and a list's default range is provided the label property is used as a text.

Since 3.17.0

toString back 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

public Class CompletionItem

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail