org.eclipse.lsp4j.debug

Class CompletionItem

java.lang.Object

org.eclipse.lsp4j.debug.CompletionItem

public class CompletionItem
extends java.lang.Object

CompletionItems are the suggestions returned from the CompletionsRequest.

Constructor Summary

Constructors

Constructor and Description
CompletionItem()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getLabel() The label of this completion item.
java.lang.Integer	getLength() This value determines how many characters are overwritten by the completion text.
java.lang.String	getSortText() A string that should be used when comparing this item with other items.
java.lang.Integer	getStart() This value determines the location (in the CompletionsRequest's 'text' attribute) where the completion text is added.
java.lang.String	getText() If text is not falsy then it is inserted instead of the label.
CompletionItemType	getType() The item's type.
int	hashCode()
void	setLabel(java.lang.String label) The label of this completion item.
void	setLength(java.lang.Integer length) This value determines how many characters are overwritten by the completion text.
void	setSortText(java.lang.String sortText) A string that should be used when comparing this item with other items.
void	setStart(java.lang.Integer start) This value determines the location (in the CompletionsRequest's 'text' attribute) where the completion text is added.
void	setText(java.lang.String text) If text is not falsy then it is inserted instead of the label.
void	setType(CompletionItemType type) The item's type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CompletionItem

public CompletionItem()

Method Detail

getLabel

@Pure
public java.lang.String getLabel()

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

setLabel

public void setLabel(java.lang.String label)

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

getText

@Pure
public java.lang.String getText()

If text is not falsy then it is inserted instead of the label.

This is an optional property.

setText

public void setText(java.lang.String text)

If text is not falsy then it is inserted instead of the label.

This is an optional property.

getSortText

@Pure
public java.lang.String getSortText()

A string that should be used when comparing this item with other items. When `falsy` the label is used.

This is an optional property.

setSortText

public void setSortText(java.lang.String sortText)

A string that should be used when comparing this item with other items. When `falsy` the label is used.

This is an optional property.

getType

@Pure
public CompletionItemType getType()

The item's type. Typically the client uses this information to render the item in the UI with an icon.

This is an optional property.

setType

public void setType(CompletionItemType type)

The item's type. Typically the client uses this information to render the item in the UI with an icon.

This is an optional property.

getStart

@Pure
public java.lang.Integer getStart()

This value determines the location (in the CompletionsRequest's 'text' attribute) where the completion text is added.

If missing the text is added at the location specified by the CompletionsRequest's 'column' attribute.

This is an optional property.

setStart

public void setStart(java.lang.Integer start)

This value determines the location (in the CompletionsRequest's 'text' attribute) where the completion text is added.

If missing the text is added at the location specified by the CompletionsRequest's 'column' attribute.

This is an optional property.

getLength

@Pure
public java.lang.Integer getLength()

This value determines how many characters are overwritten by the completion text.

If missing the value 0 is assumed which results in the completion text being inserted.

This is an optional property.

setLength

public void setLength(java.lang.Integer length)

This value determines how many characters are overwritten by the completion text.

If missing the value 0 is assumed which results in the completion text being inserted.

This is an optional property.

toString

@Pure
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

@Pure
public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

@Pure
public int hashCode()

Overrides:

hashCode in class java.lang.Object