Package org.eclipse.lsp4j.debug

Class Module

  • public class Module
extends java.lang.Object
    A Module object represents a row in the modules view.

    The `id` attribute identifies a module in the modules view and is used in a `module` event for identifying a module for adding, updating or deleting.

    The `name` attribute is used to minimally render the module in the UI.

    Additional attributes can be added to the module. They show up in the module view if they have a corresponding ColumnDescriptor.

    To avoid an unnecessary proliferation of additional attributes with similar semantics but different names, we recommend to re-use attributes from the 'recommended' list below first, and only introduce new attributes if nothing appropriate could be found.

    • Constructor Summary

      Constructors 
      Constructor Description
      Module()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getAddressRange()
      Address range covered by this module.
      java.lang.String getDateTimeStamp()
      Module created or modified, encoded as a RFC 3339 timestamp.
      org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Integer,​java.lang.String> getId()
      Unique identifier for the module.
      java.lang.Boolean getIsOptimized()
      True if the module is optimized.
      java.lang.Boolean getIsUserCode()
      True if the module is considered 'user code' by a debugger that supports 'Just My Code'.
      java.lang.String getName()
      A name of the module.
      java.lang.String getPath()
      Logical full path to the module.
      java.lang.String getSymbolFilePath()
      Logical full path to the symbol file.
      java.lang.String getSymbolStatus()
      User-understandable description of if symbols were found for the module (ex: 'Symbols Loaded', 'Symbols not found', etc.)
      java.lang.String getVersion()
      Version of Module.
      int hashCode()  
      void setAddressRange​(java.lang.String addressRange)
      Address range covered by this module.
      void setDateTimeStamp​(java.lang.String dateTimeStamp)
      Module created or modified, encoded as a RFC 3339 timestamp.
      void setId​(java.lang.Integer id)  
      void setId​(java.lang.String id)  
      void setId​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Integer,​java.lang.String> id)
      Unique identifier for the module.
      void setIsOptimized​(java.lang.Boolean isOptimized)
      True if the module is optimized.
      void setIsUserCode​(java.lang.Boolean isUserCode)
      True if the module is considered 'user code' by a debugger that supports 'Just My Code'.
      void setName​(java.lang.String name)
      A name of the module.
      void setPath​(java.lang.String path)
      Logical full path to the module.
      void setSymbolFilePath​(java.lang.String symbolFilePath)
      Logical full path to the symbol file.
      void setSymbolStatus​(java.lang.String symbolStatus)
      User-understandable description of if symbols were found for the module (ex: 'Symbols Loaded', 'Symbols not found', etc.)
      void setVersion​(java.lang.String version)
      Version of Module.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Module

        public Module()

    • Method Detail

      • getId

        public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Integer,​java.lang.String> getId()
        Unique identifier for the module.

      • setId

        public void setId​(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Integer,​java.lang.String> id)
        Unique identifier for the module.

      • setId

        public void setId​(java.lang.Integer id)

      • setId

        public void setId​(java.lang.String id)

      • getName

        public java.lang.String getName()
        A name of the module.

      • setName

        public void setName​(java.lang.String name)
        A name of the module.

      • getPath

        public java.lang.String getPath()
        Logical full path to the module. The exact definition is implementation defined, but usually this would be a full path to the on-disk file for the module.

        This is an optional property.

      • setPath

        public void setPath​(java.lang.String path)
        Logical full path to the module. The exact definition is implementation defined, but usually this would be a full path to the on-disk file for the module.

        This is an optional property.

      • getIsOptimized

        public java.lang.Boolean getIsOptimized()
        True if the module is optimized.

        This is an optional property.

      • setIsOptimized

        public void setIsOptimized​(java.lang.Boolean isOptimized)
        True if the module is optimized.

        This is an optional property.

      • getIsUserCode

        public java.lang.Boolean getIsUserCode()
        True if the module is considered 'user code' by a debugger that supports 'Just My Code'.

        This is an optional property.

      • setIsUserCode

        public void setIsUserCode​(java.lang.Boolean isUserCode)
        True if the module is considered 'user code' by a debugger that supports 'Just My Code'.

        This is an optional property.

      • getVersion

        public java.lang.String getVersion()
        Version of Module.

        This is an optional property.

      • setVersion

        public void setVersion​(java.lang.String version)
        Version of Module.

        This is an optional property.

      • getSymbolStatus

        public java.lang.String getSymbolStatus()
        User-understandable description of if symbols were found for the module (ex: 'Symbols Loaded', 'Symbols not found', etc.)

        This is an optional property.

      • setSymbolStatus

        public void setSymbolStatus​(java.lang.String symbolStatus)
        User-understandable description of if symbols were found for the module (ex: 'Symbols Loaded', 'Symbols not found', etc.)

        This is an optional property.

      • getSymbolFilePath

        public java.lang.String getSymbolFilePath()
        Logical full path to the symbol file. The exact definition is implementation defined.

        This is an optional property.

      • setSymbolFilePath

        public void setSymbolFilePath​(java.lang.String symbolFilePath)
        Logical full path to the symbol file. The exact definition is implementation defined.

        This is an optional property.

      • getDateTimeStamp

        public java.lang.String getDateTimeStamp()
        Module created or modified, encoded as a RFC 3339 timestamp.

        This is an optional property.

      • setDateTimeStamp

        public void setDateTimeStamp​(java.lang.String dateTimeStamp)
        Module created or modified, encoded as a RFC 3339 timestamp.

        This is an optional property.

      • getAddressRange

        public java.lang.String getAddressRange()
        Address range covered by this module.

        This is an optional property.

      • setAddressRange

        public void setAddressRange​(java.lang.String addressRange)
        Address range covered by this module.

        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