Eclipse LSP4J 0.24.0 · org.eclipse.lsp4j.SignatureHelp

Modifier and Type	Field and Description
private Integer	activeParameter The active parameter of the active signature.
private Integer	activeSignature The active signature.
private List<SignatureInformation>	signatures One or more signatures.

Access	Constructor and Description
public	SignatureHelp()
public	SignatureHelp(final List<SignatureInformation> signatures, final Integer activeSignature, final Integer activeParameter)

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 Integer	getActiveParameter() The active parameter of the active signature.
public Integer	getActiveSignature() The active signature.
public List<SignatureInformation>	getSignatures() One or more signatures.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setActiveParameter(final Integer activeParameter) The active parameter of the active signature.
public void	setActiveSignature(final Integer activeSignature) The active signature.
public void	setSignatures(final List<SignatureInformation> signatures) One or more signatures.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Field Detail

activeParameter back to summary

activeParameter	back to summary
private Integer activeParameter The active parameter of the active signature. If omitted or the value lies outside the range of `signatures[activeSignature].parameters` defaults to 0 if the active signature has parameters. If the active signature has no parameters it is ignored. In future version of the protocol this property might become mandatory to better express the active parameter if the active signature does have any.

private Integer activeParameter

The active parameter of the active signature. If omitted or the value lies outside the range of signatures[activeSignature].parameters defaults to 0 if the active signature has parameters. If the active signature has no parameters it is ignored.

In future version of the protocol this property might become mandatory to better express the active parameter if the active signature does have any.

activeSignature back to summary

activeSignature	back to summary
private Integer activeSignature The active signature. If omitted or the value lies outside the range of `signatures` the value defaults to zero or is ignored if the `SignatureHelp` has no signatures. Whenever possible implementors should make an active decision about the active signature and shouldn't rely on a default value. In future version of the protocol this property might become mandatory to better express this.

private Integer activeSignature

The active signature. If omitted or the value lies outside the range of signatures the value defaults to zero or is ignored if the SignatureHelp has no signatures. Whenever possible implementors should make an active decision about the active signature and shouldn't rely on a default value.

In future version of the protocol this property might become mandatory to better express this.

signatures	back to summary
private List<SignatureInformation> signatures One or more signatures. Annotations @NonNull

Constructor Detail

SignatureHelp	back to summary
public SignatureHelp()

SignatureHelp	back to summary
public SignatureHelp(final List<SignatureInformation> signatures, final Integer activeSignature, final Integer activeParameter)

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

getActiveParameter back to summary

getActiveParameter	back to summary
public Integer getActiveParameter() The active parameter of the active signature. If omitted or the value lies outside the range of `signatures[activeSignature].parameters` defaults to 0 if the active signature has parameters. If the active signature has no parameters it is ignored. In future version of the protocol this property might become mandatory to better express the active parameter if the active signature does have any.

public Integer getActiveParameter()

The active parameter of the active signature. If omitted or the value lies outside the range of signatures[activeSignature].parameters defaults to 0 if the active signature has parameters. If the active signature has no parameters it is ignored.

In future version of the protocol this property might become mandatory to better express the active parameter if the active signature does have any.

getActiveSignature back to summary

getActiveSignature	back to summary
public Integer getActiveSignature() The active signature. If omitted or the value lies outside the range of `signatures` the value defaults to zero or is ignored if the `SignatureHelp` has no signatures. Whenever possible implementors should make an active decision about the active signature and shouldn't rely on a default value. In future version of the protocol this property might become mandatory to better express this.

public Integer getActiveSignature()

The active signature. If omitted or the value lies outside the range of signatures the value defaults to zero or is ignored if the SignatureHelp has no signatures. Whenever possible implementors should make an active decision about the active signature and shouldn't rely on a default value.

In future version of the protocol this property might become mandatory to better express this.

getSignatures	back to summary
public List<SignatureInformation> getSignatures() One or more signatures. Annotations @NonNull

getSignatures

back to summary

public List<SignatureInformation> getSignatures()

One or more signatures.

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

setActiveParameter back to summary

setActiveParameter	back to summary
public void setActiveParameter(final Integer activeParameter) The active parameter of the active signature. If omitted or the value lies outside the range of `signatures[activeSignature].parameters` defaults to 0 if the active signature has parameters. If the active signature has no parameters it is ignored. In future version of the protocol this property might become mandatory to better express the active parameter if the active signature does have any.

public void setActiveParameter(final Integer activeParameter)

The active parameter of the active signature. If omitted or the value lies outside the range of signatures[activeSignature].parameters defaults to 0 if the active signature has parameters. If the active signature has no parameters it is ignored.

In future version of the protocol this property might become mandatory to better express the active parameter if the active signature does have any.

setActiveSignature back to summary

setActiveSignature	back to summary
public void setActiveSignature(final Integer activeSignature) The active signature. If omitted or the value lies outside the range of `signatures` the value defaults to zero or is ignored if the `SignatureHelp` has no signatures. Whenever possible implementors should make an active decision about the active signature and shouldn't rely on a default value. In future version of the protocol this property might become mandatory to better express this.

public void setActiveSignature(final Integer activeSignature)

The active signature. If omitted or the value lies outside the range of signatures the value defaults to zero or is ignored if the SignatureHelp has no signatures. Whenever possible implementors should make an active decision about the active signature and shouldn't rely on a default value.

In future version of the protocol this property might become mandatory to better express this.

setSignatures	back to summary
public void setSignatures(final List<SignatureInformation> signatures) One or more signatures.

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 SignatureHelp

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail