org.eclipse.lsp4j

Class SignatureInformation

java.lang.Object

org.eclipse.lsp4j.SignatureInformation

public class SignatureInformation
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
SignatureInformation()
SignatureInformation(java.lang.String label)
SignatureInformation(java.lang.String label, MarkupContent documentation, java.util.List<ParameterInformation> parameters)
SignatureInformation(java.lang.String label, java.lang.String documentation, java.util.List<ParameterInformation> parameters)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,MarkupContent>	getDocumentation() The human-readable doc-comment of this signature.
java.lang.String	getLabel() The label of this signature.
java.util.List<ParameterInformation>	getParameters() The parameters of this signature.
int	hashCode()
void	setDocumentation(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,MarkupContent> documentation) The human-readable doc-comment of this signature.
void	setDocumentation(MarkupContent documentation)
void	setDocumentation(java.lang.String documentation)
void	setLabel(java.lang.String label) The label of this signature.
void	setParameters(java.util.List<ParameterInformation> parameters) The parameters of this signature.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SignatureInformation

public SignatureInformation()

SignatureInformation

public SignatureInformation(java.lang.String label)

SignatureInformation

public SignatureInformation(java.lang.String label,
                            java.lang.String documentation,
                            java.util.List<ParameterInformation> parameters)

SignatureInformation

public SignatureInformation(java.lang.String label,
                            MarkupContent documentation,
                            java.util.List<ParameterInformation> parameters)

Method Detail

getLabel

@Pure
public java.lang.String getLabel()

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

setLabel

public void setLabel(java.lang.String label)

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

getDocumentation

@Pure
public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,MarkupContent> getDocumentation()

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

setDocumentation

public void setDocumentation(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,MarkupContent> documentation)

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

setDocumentation

public void setDocumentation(java.lang.String documentation)

setDocumentation

public void setDocumentation(MarkupContent documentation)

getParameters

@Pure
public java.util.List<ParameterInformation> getParameters()

The parameters of this signature.

setParameters

public void setParameters(java.util.List<ParameterInformation> parameters)

The parameters of this signature.

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