public class Module
extends java.lang.Object
Two attributes are mandatory: an id identifies a module in the modules view and is used in a ModuleEvent for identifying a module for adding, updating or deleting.
The name is used to minimally render the module in the UI.
Additional attributes can be added to the module. They will 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 and Description |
---|
Module() |
Modifier and Type | Method and 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.
|
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()
optional but recommended attributes.
|
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.
|
void |
setId(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Integer,java.lang.String> id)
Unique identifier for the module.
|
void |
setId(java.lang.Integer id) |
void |
setId(java.lang.String id) |
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)
optional but recommended attributes.
|
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() |
@Pure public org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Integer,java.lang.String> getId()
public void setId(org.eclipse.lsp4j.jsonrpc.messages.Either<java.lang.Integer,java.lang.String> id)
public void setId(java.lang.Integer id)
public void setId(java.lang.String id)
@Pure public java.lang.String getName()
public void setName(java.lang.String name)
@Pure public java.lang.String getPath()
always try to use these first before introducing additional attributes.
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.
public void setPath(java.lang.String path)
always try to use these first before introducing additional attributes.
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.
@Pure public java.lang.Boolean getIsOptimized()
This is an optional property.
public void setIsOptimized(java.lang.Boolean isOptimized)
This is an optional property.
@Pure public java.lang.Boolean getIsUserCode()
This is an optional property.
public void setIsUserCode(java.lang.Boolean isUserCode)
This is an optional property.
@Pure public java.lang.String getVersion()
This is an optional property.
public void setVersion(java.lang.String version)
This is an optional property.
@Pure public java.lang.String getSymbolStatus()
This is an optional property.
public void setSymbolStatus(java.lang.String symbolStatus)
This is an optional property.
@Pure public java.lang.String getSymbolFilePath()
This is an optional property.
public void setSymbolFilePath(java.lang.String symbolFilePath)
This is an optional property.
@Pure public java.lang.String getDateTimeStamp()
This is an optional property.
public void setDateTimeStamp(java.lang.String dateTimeStamp)
This is an optional property.
@Pure public java.lang.String getAddressRange()
This is an optional property.
public void setAddressRange(java.lang.String addressRange)
This is an optional property.
@Pure public java.lang.String toString()
toString
in class java.lang.Object
@Pure public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
@Pure public int hashCode()
hashCode
in class java.lang.Object