org.eclipse.lsp4j

Class ParameterInformation

java.lang.Object

org.eclipse.lsp4j.ParameterInformation

public class ParameterInformation
extends java.lang.Object

Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.

Constructor Summary

Constructors

Constructor and Description
ParameterInformation()
ParameterInformation(java.lang.String label)
ParameterInformation(java.lang.String label, MarkupContent documentation)
ParameterInformation(java.lang.String label, java.lang.String documentation)

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.
org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,org.eclipse.lsp4j.jsonrpc.messages.Tuple.Two<java.lang.Integer,java.lang.Integer>>	getLabel() The label of this parameter information.
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(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,org.eclipse.lsp4j.jsonrpc.messages.Tuple.Two<java.lang.Integer,java.lang.Integer>> label) The label of this parameter information.
void	setLabel(java.lang.String label)
void	setLabel(org.eclipse.lsp4j.jsonrpc.messages.Tuple.Two<java.lang.Integer,java.lang.Integer> label)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterInformation

public ParameterInformation()

ParameterInformation

public ParameterInformation(java.lang.String label)

ParameterInformation

public ParameterInformation(java.lang.String label,
                            java.lang.String documentation)

ParameterInformation

public ParameterInformation(java.lang.String label,
                            MarkupContent documentation)

Method Detail

getLabel

@Pure
public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,org.eclipse.lsp4j.jsonrpc.messages.Tuple.Two<java.lang.Integer,java.lang.Integer>> getLabel()

The label of this parameter information.

Either a string or an inclusive start and exclusive end offsets within its containing signature label (see SignatureInformation.label). The offsets are based on a UTF-16 string representation as Position and Range does.

Note: a label of type string should be a substring of its containing signature label. Its intended use case is to highlight the parameter label part in the SignatureInformation.label.

setLabel

public void setLabel(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.String,org.eclipse.lsp4j.jsonrpc.messages.Tuple.Two<java.lang.Integer,java.lang.Integer>> label)

The label of this parameter information.

Either a string or an inclusive start and exclusive end offsets within its containing signature label (see SignatureInformation.label). The offsets are based on a UTF-16 string representation as Position and Range does.

Note: a label of type string should be a substring of its containing signature label. Its intended use case is to highlight the parameter label part in the SignatureInformation.label.

setLabel

public void setLabel(java.lang.String label)

setLabel

public void setLabel(org.eclipse.lsp4j.jsonrpc.messages.Tuple.Two<java.lang.Integer,java.lang.Integer> label)

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)

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