Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.SignatureHelpContext

Modifier and Type	Field and Description
private SignatureHelp	activeSignatureHelp The currently active `SignatureHelp`.
private boolean	isRetrigger `true` if signature help was already showing when it was triggered.
private String	triggerCharacter Character that caused signature help to be triggered.
private SignatureHelpTriggerKind	triggerKind Action that caused signature help to be triggered.

Access	Constructor and Description
public	SignatureHelpContext()
public	SignatureHelpContext(final SignatureHelpTriggerKind triggerKind, final boolean isRetrigger)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public SignatureHelp	getActiveSignatureHelp() The currently active `SignatureHelp`.
public String	getTriggerCharacter() Character that caused signature help to be triggered.
public SignatureHelpTriggerKind	getTriggerKind() Action that caused signature help to be triggered.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isRetrigger() `true` if signature help was already showing when it was triggered.
public void	setActiveSignatureHelp(final SignatureHelp activeSignatureHelp) The currently active `SignatureHelp`.
public void	setIsRetrigger(final boolean isRetrigger) `true` if signature help was already showing when it was triggered.
public void	setTriggerCharacter(final String triggerCharacter) Character that caused signature help to be triggered.
public void	setTriggerKind(final SignatureHelpTriggerKind triggerKind) Action that caused signature help to be triggered.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

activeSignatureHelp	back to summary
private SignatureHelp activeSignatureHelp The currently active `SignatureHelp`. The `activeSignatureHelp` has its `SignatureHelp#activeSignature` field updated based on the user navigating through available signatures.

isRetrigger	back to summary
private boolean isRetrigger `true` if signature help was already showing when it was triggered. Retriggers occur when the signature help is already active and can be caused by actions such as typing a trigger character, a cursor move, or document content changes.

triggerCharacter	back to summary
private String triggerCharacter Character that caused signature help to be triggered. This is undefined when `triggerKind` is not `SignatureHelpTriggerKind#TriggerCharacter`

triggerKind	back to summary
private SignatureHelpTriggerKind triggerKind Action that caused signature help to be triggered. Annotations @NonNull

SignatureHelpContext	back to summary
public SignatureHelpContext()

SignatureHelpContext	back to summary
public SignatureHelpContext(final SignatureHelpTriggerKind triggerKind, final boolean isRetrigger)

Method Detail

equals back to summary

equals	back 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

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

getActiveSignatureHelp back to summary

getActiveSignatureHelp	back to summary
public SignatureHelp getActiveSignatureHelp() The currently active `SignatureHelp`. The `activeSignatureHelp` has its `SignatureHelp#activeSignature` field updated based on the user navigating through available signatures.

public SignatureHelp getActiveSignatureHelp()

The currently active SignatureHelp.

The `activeSignatureHelp` has its SignatureHelp#activeSignature field updated based on the user navigating through available signatures.

getTriggerCharacter back to summary

getTriggerCharacter	back to summary
public String getTriggerCharacter() Character that caused signature help to be triggered. This is undefined when `triggerKind` is not `SignatureHelpTriggerKind#TriggerCharacter`

public String getTriggerCharacter()

Character that caused signature help to be triggered.

This is undefined when triggerKind is not SignatureHelpTriggerKind#TriggerCharacter

getTriggerKind	back to summary
public SignatureHelpTriggerKind getTriggerKind() Action that caused signature help to be triggered. Annotations @NonNull

getTriggerKind

back to summary

public SignatureHelpTriggerKind getTriggerKind()

Action that caused signature help to be triggered.

Annotations

@NonNull

hashCode back to summary

hashCode	back 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

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

isRetrigger back to summary

isRetrigger	back to summary
public boolean isRetrigger() `true` if signature help was already showing when it was triggered. Retriggers occur when the signature help is already active and can be caused by actions such as typing a trigger character, a cursor move, or document content changes.

public boolean isRetrigger()

true if signature help was already showing when it was triggered.

Retriggers occur when the signature help is already active and can be caused by actions such as typing a trigger character, a cursor move, or document content changes.

setActiveSignatureHelp back to summary

setActiveSignatureHelp	back to summary
public void setActiveSignatureHelp(final SignatureHelp activeSignatureHelp) The currently active `SignatureHelp`. The `activeSignatureHelp` has its `SignatureHelp#activeSignature` field updated based on the user navigating through available signatures.

public void setActiveSignatureHelp(final SignatureHelp activeSignatureHelp)

The currently active SignatureHelp.

The `activeSignatureHelp` has its SignatureHelp#activeSignature field updated based on the user navigating through available signatures.

setIsRetrigger back to summary

setIsRetrigger	back to summary
public void setIsRetrigger(final boolean isRetrigger) `true` if signature help was already showing when it was triggered. Retriggers occur when the signature help is already active and can be caused by actions such as typing a trigger character, a cursor move, or document content changes.

public void setIsRetrigger(final boolean isRetrigger)

true if signature help was already showing when it was triggered.

Retriggers occur when the signature help is already active and can be caused by actions such as typing a trigger character, a cursor move, or document content changes.

setTriggerCharacter back to summary

setTriggerCharacter	back to summary
public void setTriggerCharacter(final String triggerCharacter) Character that caused signature help to be triggered. This is undefined when `triggerKind` is not `SignatureHelpTriggerKind#TriggerCharacter`

public void setTriggerCharacter(final String triggerCharacter)

Character that caused signature help to be triggered.

This is undefined when triggerKind is not SignatureHelpTriggerKind#TriggerCharacter

setTriggerKind	back to summary
public void setTriggerKind(final SignatureHelpTriggerKind triggerKind) Action that caused signature help to be triggered.

toString back to summary

toString	back 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

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

public Class SignatureHelpContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail