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

Class SignatureInformation

java.lang.Object

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

org.graalvm.tools.lsp.server.types.SignatureInformation

public class SignatureInformation
extends JSONBase

Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.

Method Summary

Modifier and Type	Method	Description
static SignatureInformation	create(String label, String documentation, ParameterInformation... parameters)
boolean	equals(Object obj)
Object	getDocumentation()	The human-readable doc-comment of this signature.
String	getLabel()	The label of this signature.
List<ParameterInformation>	getParameters()	The parameters of this signature.
int	hashCode()
SignatureInformation	setDocumentation(Object documentation)
SignatureInformation	setLabel(String label)
SignatureInformation	setParameters(List<ParameterInformation> parameters)

Methods inherited from class java.lang.Object

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

Method Details

getLabel

public String getLabel()

The label of this signature. Will be shown in the UI.

setLabel

public SignatureInformation setLabel(String label)

getDocumentation

public Object getDocumentation()

The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.

setDocumentation

public SignatureInformation setDocumentation(Object documentation)

getParameters

public List<ParameterInformation> getParameters()

The parameters of this signature.

setParameters

public SignatureInformation setParameters(List<ParameterInformation> parameters)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

create

public static SignatureInformation create(String label,
 String documentation,
 ParameterInformation... parameters)