Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class CompletionCapabilities

extends DynamicRegistrationCapabilities
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
org.eclipse.lsp4j.jsonrpc.util.ToStringBuilder

Capabilities specific to the `textDocument/completion`

Field Summary

Modifier and TypeField and Description
private CompletionItemCapabilities
completionItem

The client supports the following CompletionItem specific capabilities.

private CompletionItemKindCapabilities
completionItemKind

The client supports the following CompletionItemKind specific capabilities.

private CompletionListCapabilities
completionList

The client supports the following CompletionList specific capabilities.

private Boolean
contextSupport

The client supports sending additional context information for a `textDocument/completion` request.

private InsertTextMode
insertTextMode

The client's default when the completion item doesn't provide a CompletionItem#insertTextMode property.

Constructor Summary

AccessConstructor and Description
public
public
public
public
CompletionCapabilities(final Boolean contextSupport)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(final Object obj)

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.equals.

Indicates whether some other object is "equal to" this one.

public CompletionItemCapabilities
getCompletionItem()

The client supports the following CompletionItem specific capabilities.

public CompletionItemKindCapabilities
getCompletionItemKind()

The client supports the following CompletionItemKind specific capabilities.

public CompletionListCapabilities
getCompletionList()

The client supports the following CompletionList specific capabilities.

public Boolean
getContextSupport()

The client supports sending additional context information for a `textDocument/completion` request.

public InsertTextMode
getInsertTextMode()

The client's default when the completion item doesn't provide a CompletionItem#insertTextMode property.

public int
hashCode()

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.hashCode.

Returns a hash code value for this object.

public void
setCompletionItem(final CompletionItemCapabilities completionItem)

The client supports the following CompletionItem specific capabilities.

public void
setCompletionItemKind(final CompletionItemKindCapabilities completionItemKind)

The client supports the following CompletionItemKind specific capabilities.

public void
setCompletionList(final CompletionListCapabilities completionList)

The client supports the following CompletionList specific capabilities.

public void
setContextSupport(final Boolean contextSupport)

The client supports sending additional context information for a `textDocument/completion` request.

public void
setInsertTextMode(final InsertTextMode insertTextMode)

The client's default when the completion item doesn't provide a CompletionItem#insertTextMode property.

public String
toString()

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.toString.

Returns a string representation of the object.

Inherited from org.eclipse.lsp4j.DynamicRegistrationCapabilities:
getDynamicRegistrationsetDynamicRegistration

Field Detail

completionItemback to summary
private CompletionItemCapabilities completionItem

The client supports the following CompletionItem specific capabilities.

completionItemKindback to summary
private CompletionItemKindCapabilities completionItemKind

The client supports the following CompletionItemKind specific capabilities.

Since 3.4.0

completionListback to summary
private CompletionListCapabilities completionList

The client supports the following CompletionList specific capabilities.

Since 3.17.0

contextSupportback to summary
private Boolean contextSupport

The client supports sending additional context information for a `textDocument/completion` request.

Since 3.3.0

insertTextModeback to summary
private InsertTextMode insertTextMode

The client's default when the completion item doesn't provide a CompletionItem#insertTextMode property.

Since 3.17.0

Constructor Detail

CompletionCapabilitiesback to summary
public CompletionCapabilities()
CompletionCapabilitiesback to summary
public CompletionCapabilities(final CompletionItemCapabilities completionItem)
CompletionCapabilitiesback to summary
public CompletionCapabilities(final CompletionItemKindCapabilities completionItemKind)
CompletionCapabilitiesback to summary
public CompletionCapabilities(final Boolean contextSupport)

Method Detail

equalsback to summary
public boolean equals(final Object obj)

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.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
getCompletionItemback to summary
public CompletionItemCapabilities getCompletionItem()

The client supports the following CompletionItem specific capabilities.

getCompletionItemKindback to summary
public CompletionItemKindCapabilities getCompletionItemKind()

The client supports the following CompletionItemKind specific capabilities.

Since 3.4.0

getCompletionListback to summary
public CompletionListCapabilities getCompletionList()

The client supports the following CompletionList specific capabilities.

Since 3.17.0

getContextSupportback to summary
public Boolean getContextSupport()

The client supports sending additional context information for a `textDocument/completion` request.

Since 3.3.0

getInsertTextModeback to summary
public InsertTextMode getInsertTextMode()

The client's default when the completion item doesn't provide a CompletionItem#insertTextMode property.

Since 3.17.0

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.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
setCompletionItemback to summary
public void setCompletionItem(final CompletionItemCapabilities completionItem)

The client supports the following CompletionItem specific capabilities.

setCompletionItemKindback to summary
public void setCompletionItemKind(final CompletionItemKindCapabilities completionItemKind)

The client supports the following CompletionItemKind specific capabilities.

Since 3.4.0

setCompletionListback to summary
public void setCompletionList(final CompletionListCapabilities completionList)

The client supports the following CompletionList specific capabilities.

Since 3.17.0

setContextSupportback to summary
public void setContextSupport(final Boolean contextSupport)

The client supports sending additional context information for a `textDocument/completion` request.

Since 3.3.0

setInsertTextModeback to summary
public void setInsertTextMode(final InsertTextMode insertTextMode)

The client's default when the completion item doesn't provide a CompletionItem#insertTextMode property.

Since 3.17.0

toStringback to summary
public String toString()

Overrides org.eclipse.lsp4j.DynamicRegistrationCapabilities.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