Top Description Fields Constructors Methods
org.eclipse.lsp4j

public Class SignatureHelpOptions

extends AbstractWorkDoneProgressOptions
Class Inheritance
Annotations
@SuppressWarnings:all
Imports
java.util.List, org.eclipse.lsp4j.jsonrpc.util.ToStringBuilder

Signature help options.

Field Summary

Modifier and TypeField and Description
private List<String>
retriggerCharacters

List of characters that re-trigger signature help.

private List<String>
triggerCharacters

The characters that trigger signature help automatically.

Constructor Summary

AccessConstructor and Description
public
public
SignatureHelpOptions(final List<String> triggerCharacters)

public
SignatureHelpOptions(final List<String> triggerCharacters, final List<String> retriggerCharacters)

Method Summary

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

Overrides org.eclipse.lsp4j.AbstractWorkDoneProgressOptions.equals.

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

public List<String>
getRetriggerCharacters()

List of characters that re-trigger signature help.

public List<String>
getTriggerCharacters()

The characters that trigger signature help automatically.

public int
hashCode()

Overrides org.eclipse.lsp4j.AbstractWorkDoneProgressOptions.hashCode.

Returns a hash code value for this object.

public void
setRetriggerCharacters(final List<String> retriggerCharacters)

List of characters that re-trigger signature help.

public void
setTriggerCharacters(final List<String> triggerCharacters)

The characters that trigger signature help automatically.

public String
toString()

Overrides org.eclipse.lsp4j.AbstractWorkDoneProgressOptions.toString.

Returns a string representation of the object.

Inherited from org.eclipse.lsp4j.AbstractWorkDoneProgressOptions:
getWorkDoneProgresssetWorkDoneProgress

Field Detail

retriggerCharactersback to summary
private List<String> retriggerCharacters

List of characters that re-trigger signature help.

These trigger characters are only active when signature help is already showing. All trigger characters are also counted as re-trigger characters.

Since 3.15.0

triggerCharactersback to summary
private List<String> triggerCharacters

The characters that trigger signature help automatically.

Constructor Detail

SignatureHelpOptionsback to summary
public SignatureHelpOptions()
SignatureHelpOptionsback to summary
public SignatureHelpOptions(final List<String> triggerCharacters)
SignatureHelpOptionsback to summary
public SignatureHelpOptions(final List<String> triggerCharacters, final List<String> retriggerCharacters)

Method Detail

equalsback to summary
public boolean equals(final Object obj)

Overrides org.eclipse.lsp4j.AbstractWorkDoneProgressOptions.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
getRetriggerCharactersback to summary
public List<String> getRetriggerCharacters()

List of characters that re-trigger signature help.

These trigger characters are only active when signature help is already showing. All trigger characters are also counted as re-trigger characters.

Since 3.15.0

getTriggerCharactersback to summary
public List<String> getTriggerCharacters()

The characters that trigger signature help automatically.

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.lsp4j.AbstractWorkDoneProgressOptions.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
setRetriggerCharactersback to summary
public void setRetriggerCharacters(final List<String> retriggerCharacters)

List of characters that re-trigger signature help.

These trigger characters are only active when signature help is already showing. All trigger characters are also counted as re-trigger characters.

Since 3.15.0

setTriggerCharactersback to summary
public void setTriggerCharacters(final List<String> triggerCharacters)

The characters that trigger signature help automatically.

toStringback to summary
public String toString()

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