org.eclipse.lsp4j

Class SignatureHelp

java.lang.Object

org.eclipse.lsp4j.SignatureHelp

public class SignatureHelp
extends java.lang.Object

Signature help represents the signature of something callable. There can be multiple signature but only one active and only one active parameter.

Constructor Summary

Constructors

Constructor and Description
SignatureHelp()
SignatureHelp(java.util.List<SignatureInformation> signatures, java.lang.Integer activeSignature, java.lang.Integer activeParameter)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Integer	getActiveParameter() The active parameter of the active signature.
java.lang.Integer	getActiveSignature() The active signature.
java.util.List<SignatureInformation>	getSignatures() One or more signatures.
int	hashCode()
void	setActiveParameter(java.lang.Integer activeParameter) The active parameter of the active signature.
void	setActiveSignature(java.lang.Integer activeSignature) The active signature.
void	setSignatures(java.util.List<SignatureInformation> signatures) One or more signatures.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SignatureHelp

public SignatureHelp()

SignatureHelp

public SignatureHelp(java.util.List<SignatureInformation> signatures,
                     java.lang.Integer activeSignature,
                     java.lang.Integer activeParameter)

Method Detail

getSignatures

@Pure
public java.util.List<SignatureInformation> getSignatures()

One or more signatures.

setSignatures

public void setSignatures(java.util.List<SignatureInformation> signatures)

One or more signatures.

getActiveSignature

@Pure
public java.lang.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.

setActiveSignature

public void setActiveSignature(java.lang.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.

getActiveParameter

@Pure
public java.lang.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.

setActiveParameter

public void setActiveParameter(java.lang.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.

toString

@Pure
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

@Pure
public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

@Pure
public int hashCode()

Overrides:

hashCode in class java.lang.Object