Package org.graalvm.tools.lsp.server.types

Class SignatureHelp

java.lang.Object

org.graalvm.tools.lsp.server.types.JSONBase

org.graalvm.tools.lsp.server.types.SignatureHelp

public class SignatureHelp
extends JSONBase

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

Method Summary

Modifier and Type	Method	Description
static SignatureHelp	create(List<SignatureInformation> signatures, Integer activeSignature, Integer activeParameter)
boolean	equals(Object obj)
Integer	getActiveParameter()	The active parameter of the active signature.
Integer	getActiveSignature()	The active signature.
List<SignatureInformation>	getSignatures()	One or more signatures.
int	hashCode()
SignatureHelp	setActiveParameter(Integer activeParameter)
SignatureHelp	setActiveSignature(Integer activeSignature)
SignatureHelp	setSignatures(List<SignatureInformation> signatures)

Methods inherited from class java.lang.Object

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

Method Details

getSignatures

public List<SignatureInformation> getSignatures()

One or more signatures.

setSignatures

public SignatureHelp setSignatures(List<SignatureInformation> signatures)

getActiveSignature

public Integer getActiveSignature()

The active signature. Set to `null` if no signatures exist.

setActiveSignature

public SignatureHelp setActiveSignature(Integer activeSignature)

getActiveParameter

public Integer getActiveParameter()

The active parameter of the active signature. Set to `null` if the active signature has no parameters.

setActiveParameter

public SignatureHelp setActiveParameter(Integer activeParameter)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

create

public static SignatureHelp create(List<SignatureInformation> signatures,
 Integer activeSignature,
 Integer activeParameter)