Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class CompletionList

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

Represents a collection of completion items to be presented in the editor.

Field Summary

Modifier and TypeField and Description
private boolean
isIncomplete

This list is not complete.

private CompletionItemDefaults
itemDefaults

In many cases the items of an actual completion result share the same value for properties like CompletionItem#commitCharacters or the range of a text edit.

private List<CompletionItem>
items

The completion items.

Constructor Summary

AccessConstructor and Description
public
public
public
CompletionList(final boolean isIncomplete, final List<CompletionItem> items)

public
CompletionList(final boolean isIncomplete, final List<CompletionItem> items, final CompletionItemDefaults itemDefaults)

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 CompletionItemDefaults
getItemDefaults()

In many cases the items of an actual completion result share the same value for properties like CompletionItem#commitCharacters or the range of a text edit.

public List<CompletionItem>
getItems()

The completion items.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
isIncomplete()

This list is not complete.

public void
setIsIncomplete(final boolean isIncomplete)

This list is not complete.

public void
setItemDefaults(final CompletionItemDefaults itemDefaults)

In many cases the items of an actual completion result share the same value for properties like CompletionItem#commitCharacters or the range of a text edit.

public void
setItems(final List<CompletionItem> items)

The completion items.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

isIncompleteback to summary
private boolean isIncomplete

This list is not complete. Further typing should result in recomputing this list.

itemDefaultsback to summary
private CompletionItemDefaults itemDefaults

In many cases the items of an actual completion result share the same value for properties like CompletionItem#commitCharacters or the range of a text edit. A completion list can therefore define item defaults which will be used if a completion item itself doesn't specify the value.

If a completion list specifies a default value and a completion item also specifies a corresponding value the one from the item is used.

Servers are only allowed to return default values if the client signals support for this via the CompletionListCapabilities#itemDefaults capability.

Since 3.17.0

itemsback to summary
private List<CompletionItem> items

The completion items.

Annotations
@NonNull

Constructor Detail

CompletionListback to summary
public CompletionList()
CompletionListback to summary
public CompletionList(final List<CompletionItem> items)
CompletionListback to summary
public CompletionList(final boolean isIncomplete, final List<CompletionItem> items)
CompletionListback to summary
public CompletionList(final boolean isIncomplete, final List<CompletionItem> items, final CompletionItemDefaults itemDefaults)

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
getItemDefaultsback to summary
public CompletionItemDefaults getItemDefaults()

In many cases the items of an actual completion result share the same value for properties like CompletionItem#commitCharacters or the range of a text edit. A completion list can therefore define item defaults which will be used if a completion item itself doesn't specify the value.

If a completion list specifies a default value and a completion item also specifies a corresponding value the one from the item is used.

Servers are only allowed to return default values if the client signals support for this via the CompletionListCapabilities#itemDefaults capability.

Since 3.17.0

getItemsback to summary
public List<CompletionItem> getItems()

The completion items.

Annotations
@NonNull
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
isIncompleteback to summary
public boolean isIncomplete()

This list is not complete. Further typing should result in recomputing this list.

setIsIncompleteback to summary
public void setIsIncomplete(final boolean isIncomplete)

This list is not complete. Further typing should result in recomputing this list.

setItemDefaultsback to summary
public void setItemDefaults(final CompletionItemDefaults itemDefaults)

In many cases the items of an actual completion result share the same value for properties like CompletionItem#commitCharacters or the range of a text edit. A completion list can therefore define item defaults which will be used if a completion item itself doesn't specify the value.

If a completion list specifies a default value and a completion item also specifies a corresponding value the one from the item is used.

Servers are only allowed to return default values if the client signals support for this via the CompletionListCapabilities#itemDefaults capability.

Since 3.17.0

setItemsback to summary
public void setItems(final List<CompletionItem> items)

The completion items.

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