Package org.eclipse.lsp4j.debug

Class VariablesArguments

  • public class VariablesArguments
extends java.lang.Object
    Arguments for 'variables' request.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.Integer getCount()
      The number of variables to return.
      VariablesArgumentsFilter getFilter()
      Filter to limit the child variables to either named or indexed.
      ValueFormat getFormat()
      Specifies details on how to format the Variable values.
      java.lang.Integer getStart()
      The index of the first variable to return; if omitted children start at 0.
      int getVariablesReference()
      The variable for which to retrieve its children.
      int hashCode()  
      void setCount​(java.lang.Integer count)
      The number of variables to return.
      void setFilter​(VariablesArgumentsFilter filter)
      Filter to limit the child variables to either named or indexed.
      void setFormat​(ValueFormat format)
      Specifies details on how to format the Variable values.
      void setStart​(java.lang.Integer start)
      The index of the first variable to return; if omitted children start at 0.
      void setVariablesReference​(int variablesReference)
      The variable for which to retrieve its children.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • VariablesArguments

        public VariablesArguments()

    • Method Detail

      • getVariablesReference

        public int getVariablesReference()
        The variable for which to retrieve its children. The `variablesReference` must have been obtained in the current suspended state. See 'Lifetime of Object References' in the DebugProtocol.Overview section for details.

      • setVariablesReference

        public void setVariablesReference​(int variablesReference)
        The variable for which to retrieve its children. The `variablesReference` must have been obtained in the current suspended state. See 'Lifetime of Object References' in the DebugProtocol.Overview section for details.

      • getFilter

        public VariablesArgumentsFilter getFilter()
        Filter to limit the child variables to either named or indexed. If omitted, both types are fetched.

        This is an optional property.

      • setFilter

        public void setFilter​(VariablesArgumentsFilter filter)
        Filter to limit the child variables to either named or indexed. If omitted, both types are fetched.

        This is an optional property.

      • getStart

        public java.lang.Integer getStart()
        The index of the first variable to return; if omitted children start at 0.

        The attribute is only honored by a debug adapter if the corresponding capability InitializeRequestArguments.getSupportsVariablePaging() is true.

        This is an optional property.

      • setStart

        public void setStart​(java.lang.Integer start)
        The index of the first variable to return; if omitted children start at 0.

        The attribute is only honored by a debug adapter if the corresponding capability InitializeRequestArguments.getSupportsVariablePaging() is true.

        This is an optional property.

      • getCount

        public java.lang.Integer getCount()
        The number of variables to return. If count is missing or 0, all variables are returned.

        The attribute is only honored by a debug adapter if the corresponding capability InitializeRequestArguments.getSupportsVariablePaging() is true.

        This is an optional property.

      • setCount

        public void setCount​(java.lang.Integer count)
        The number of variables to return. If count is missing or 0, all variables are returned.

        The attribute is only honored by a debug adapter if the corresponding capability InitializeRequestArguments.getSupportsVariablePaging() is true.

        This is an optional property.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object