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

Class SignatureHelpContext

java.lang.Object
org.graalvm.tools.lsp.server.types.JSONBase
org.graalvm.tools.lsp.server.types.SignatureHelpContext
public class SignatureHelpContext extends JSONBase
Additional information about the context in which a signature help request was triggered.
Since:
3.15.0

  • Method Details

    • getTriggerKind

      public SignatureHelpTriggerKind getTriggerKind()
      Action that caused signature help to be triggered.

    • setTriggerKind

      public SignatureHelpContext setTriggerKind(SignatureHelpTriggerKind triggerKind)

    • getTriggerCharacter

      public String getTriggerCharacter()
      Character that caused signature help to be triggered. This is undefined when `triggerKind !== SignatureHelpTriggerKind.TriggerCharacter`

    • setTriggerCharacter

      public SignatureHelpContext setTriggerCharacter(String triggerCharacter)

    • isRetrigger

      public boolean isRetrigger()
      `true` if signature help was already showing when it was triggered. Retriggers occur when the signature help is already active and can be caused by actions such as typing a trigger character, a cursor move, or document content changes.

    • setRetrigger

      public SignatureHelpContext setRetrigger(boolean isRetrigger)

    • getActiveSignatureHelp

      public SignatureHelp getActiveSignatureHelp()
      The currently active `SignatureHelp`. The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field updated based on the user navigating through available signatures.

    • setActiveSignatureHelp

      public SignatureHelpContext setActiveSignatureHelp(SignatureHelp activeSignatureHelp)

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • create

      public static SignatureHelpContext create(SignatureHelpTriggerKind triggerKind, Boolean isRetrigger)