Module io.quarkus.qute.debug
Package io.quarkus.qute.debug.agent.variables

Interface VariablesProvider

All Known Implementing Classes:
GlobalsScope, LocalsScope, NamespaceResolversScope, RemoteScope, RemoteVariable
public interface VariablesProvider
Represents an entity that can provide a collection of debug variables (properties, fields, or items) for inspection in the debugger.

Implementations are used by the debug agent to expose hierarchical variables, e.g., local variables, global variables, or elements of a collection/array.

  • Method Summary

    Modifier and Type
    Method
    Description
    Collection<org.eclipse.lsp4j.debug.Variable>
    getVariables()
    Returns the collection of Variable instances contained by this provider.
    int
    getVariablesReference()
    Returns the reference ID used by the debugger protocol to identify this variable container.
    void
    setVariablesReference(int variablesReference)
    Sets the reference ID for this variable container.

  • Method Details

    • getVariablesReference

      int getVariablesReference()
      Returns the reference ID used by the debugger protocol to identify this variable container.

      This allows the debugger client to request the children of this container when expanding a variable in the UI.

      Returns:
      the variables reference ID

    • setVariablesReference

      void setVariablesReference(int variablesReference)
      Sets the reference ID for this variable container.
      Parameters:
      variablesReference - the reference ID to set

    • getVariables

      Collection<org.eclipse.lsp4j.debug.Variable> getVariables()
      Returns the collection of Variable instances contained by this provider.

      This can be either simple properties or nested variables that themselves implement VariablesProvider.

      Returns:
      a collection of debug variables