public class Source
extends java.lang.Object
It is returned from the debug adapter as part of a StackFrame and it is used by clients when specifying breakpoints.
Constructor and Description |
---|
Source() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.Object |
getAdapterData()
Optional data that a debug adapter might want to loop through the client.
|
Checksum[] |
getChecksums()
The checksums associated with this file.
|
java.lang.String |
getName()
The short name of the source.
|
java.lang.String |
getOrigin()
The (optional) origin of this source: possible values 'internal module', 'inlined content from source map',
etc.
|
java.lang.String |
getPath()
The path of the source to be shown in the UI.
|
SourcePresentationHint |
getPresentationHint()
An optional hint for how to present the source in the UI.
|
java.lang.Integer |
getSourceReference()
If sourceReference > 0 the contents of the source must be retrieved through the SourceRequest (even if a
path is specified).
|
Source[] |
getSources()
An optional list of sources that are related to this source.
|
int |
hashCode() |
void |
setAdapterData(java.lang.Object adapterData)
Optional data that a debug adapter might want to loop through the client.
|
void |
setChecksums(Checksum[] checksums)
The checksums associated with this file.
|
void |
setName(java.lang.String name)
The short name of the source.
|
void |
setOrigin(java.lang.String origin)
The (optional) origin of this source: possible values 'internal module', 'inlined content from source map',
etc.
|
void |
setPath(java.lang.String path)
The path of the source to be shown in the UI.
|
void |
setPresentationHint(SourcePresentationHint presentationHint)
An optional hint for how to present the source in the UI.
|
void |
setSourceReference(java.lang.Integer sourceReference)
If sourceReference > 0 the contents of the source must be retrieved through the SourceRequest (even if a
path is specified).
|
void |
setSources(Source[] sources)
An optional list of sources that are related to this source.
|
java.lang.String |
toString() |
@Pure public java.lang.String getName()
When sending a source to the debug adapter this name is optional.
This is an optional property.
public void setName(java.lang.String name)
When sending a source to the debug adapter this name is optional.
This is an optional property.
@Pure public java.lang.String getPath()
It is only used to locate and load the content of the source if no sourceReference is specified (or its value is 0).
This is an optional property.
public void setPath(java.lang.String path)
It is only used to locate and load the content of the source if no sourceReference is specified (or its value is 0).
This is an optional property.
@Pure public java.lang.Integer getSourceReference()
A sourceReference is only valid for a session, so it must not be used to persist a source.
The value should be less than or equal to 2147483647 (2^31 - 1).
This is an optional property.
public void setSourceReference(java.lang.Integer sourceReference)
A sourceReference is only valid for a session, so it must not be used to persist a source.
The value should be less than or equal to 2147483647 (2^31 - 1).
This is an optional property.
@Pure public SourcePresentationHint getPresentationHint()
A value of 'deemphasize' can be used to indicate that the source is not available or that it is skipped on stepping.
This is an optional property.
public void setPresentationHint(SourcePresentationHint presentationHint)
A value of 'deemphasize' can be used to indicate that the source is not available or that it is skipped on stepping.
This is an optional property.
@Pure public java.lang.String getOrigin()
This is an optional property.
public void setOrigin(java.lang.String origin)
This is an optional property.
@Pure public Source[] getSources()
This is an optional property.
public void setSources(Source[] sources)
This is an optional property.
@Pure public java.lang.Object getAdapterData()
The client should leave the data intact and persist it across sessions. The client should not interpret the data.
This is an optional property.
public void setAdapterData(java.lang.Object adapterData)
The client should leave the data intact and persist it across sessions. The client should not interpret the data.
This is an optional property.
@Pure public Checksum[] getChecksums()
This is an optional property.
public void setChecksums(Checksum[] checksums)
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