Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class CompletionItemDefaults

extends Object
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
com.google.gson.annotations.JsonAdapter, java.util.List, org.eclipse.lsp4j.adapters.CompletionItemDefaultsEditRangeTypeAdapter, org.eclipse.lsp4j.jsonrpc.json.adapters.JsonElementTypeAdapter, org.eclipse.lsp4j.jsonrpc.messages.Either, org.eclipse.lsp4j.jsonrpc.util.ToStringBuilder
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

Field Summary

Modifier and TypeField and Description
private List<String>
commitCharacters

A default commit character set.

private Object
data

A default data value.

private Either<Range, InsertReplaceRange>
editRange

A default edit range

private InsertTextFormat
insertTextFormat

A default insert text format

private InsertTextMode
insertTextMode

A default insert text mode

Constructor Summary

AccessConstructor and Description
public
CompletionItemDefaults()

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 List<String>
getCommitCharacters()

A default commit character set.

public Object
getData()

A default data value.

public Either<Range, InsertReplaceRange>
getEditRange()

A default edit range

public InsertTextFormat
getInsertTextFormat()

A default insert text format

public InsertTextMode
getInsertTextMode()

A default insert text mode

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
setCommitCharacters(final List<String> commitCharacters)

A default commit character set.

public void
setData(final Object data)

A default data value.

public void
setEditRange(final Either<Range, InsertReplaceRange> editRange)

A default edit range

public void
setInsertTextFormat(final InsertTextFormat insertTextFormat)

A default insert text format

public void
setInsertTextMode(final InsertTextMode insertTextMode)

A default insert text mode

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

commitCharactersback to summary
private List<String> commitCharacters

A default commit character set.

databack to summary
private Object data

A default data value.

Annotations
@JsonAdapter:Factory
editRangeback to summary
private Either<Range, InsertReplaceRange> editRange

A default edit range

Annotations
@JsonAdapter:CompletionItemDefaultsEditRangeTypeAdapter
insertTextFormatback to summary
private InsertTextFormat insertTextFormat

A default insert text format

insertTextModeback to summary
private InsertTextMode insertTextMode

A default insert text mode

Constructor Detail

CompletionItemDefaultsback to summary
public CompletionItemDefaults()

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
getCommitCharactersback to summary
public List<String> getCommitCharacters()

A default commit character set.

getDataback to summary
public Object getData()

A default data value.

getEditRangeback to summary
public Either<Range, InsertReplaceRange> getEditRange()

A default edit range

getInsertTextFormatback to summary
public InsertTextFormat getInsertTextFormat()

A default insert text format

getInsertTextModeback to summary
public InsertTextMode getInsertTextMode()

A default insert text mode

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
setCommitCharactersback to summary
public void setCommitCharacters(final List<String> commitCharacters)

A default commit character set.

setDataback to summary
public void setData(final Object data)

A default data value.

setEditRangeback to summary
public void setEditRange(final Either<Range, InsertReplaceRange> editRange)

A default edit range

setInsertTextFormatback to summary
public void setInsertTextFormat(final InsertTextFormat insertTextFormat)

A default insert text format

setInsertTextModeback to summary
public void setInsertTextMode(final InsertTextMode insertTextMode)

A default insert text mode

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