org.eclipse.lsp4j

Class SignatureHelpParams

java.lang.Object

org.eclipse.lsp4j.TextDocumentPositionParams

org.eclipse.lsp4j.TextDocumentPositionAndWorkDoneProgressParams

org.eclipse.lsp4j.SignatureHelpParams

All Implemented Interfaces:

WorkDoneProgressParams

public class SignatureHelpParams
extends TextDocumentPositionAndWorkDoneProgressParams

The signature help request is sent from the client to the server to request signature information at a given cursor position.

Constructor Summary

Constructors

Constructor and Description
SignatureHelpParams()
SignatureHelpParams(TextDocumentIdentifier textDocument, Position position)
SignatureHelpParams(TextDocumentIdentifier textDocument, Position position, SignatureHelpContext context)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
SignatureHelpContext	getContext() The signature help context.
int	hashCode()
void	setContext(SignatureHelpContext context) The signature help context.
java.lang.String	toString()

Methods inherited from class org.eclipse.lsp4j.TextDocumentPositionAndWorkDoneProgressParams

getWorkDoneToken, setWorkDoneToken, setWorkDoneToken, setWorkDoneToken

Methods inherited from class org.eclipse.lsp4j.TextDocumentPositionParams

getPosition, getTextDocument, setPosition, setTextDocument

Methods inherited from class java.lang.Object

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

Constructor Detail

SignatureHelpParams

public SignatureHelpParams()

SignatureHelpParams

public SignatureHelpParams(TextDocumentIdentifier textDocument,
                           Position position)

SignatureHelpParams

public SignatureHelpParams(TextDocumentIdentifier textDocument,
                           Position position,
                           SignatureHelpContext context)

Method Detail

getContext

@Pure
public SignatureHelpContext getContext()

The signature help context. This is only available if the client specifies to send this using the client capability SignatureHelpCapabilities.contextSupport as true.

Since 3.15.0

setContext

public void setContext(SignatureHelpContext context)

The signature help context. This is only available if the client specifies to send this using the client capability SignatureHelpCapabilities.contextSupport as true.

Since 3.15.0

toString

@Pure
public java.lang.String toString()

Overrides:

toString in class TextDocumentPositionAndWorkDoneProgressParams

equals

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

Overrides:

equals in class TextDocumentPositionAndWorkDoneProgressParams

hashCode

@Pure
public int hashCode()

Overrides:

hashCode in class TextDocumentPositionAndWorkDoneProgressParams