Source (org.eclipse.lsp4j.debug 0.9.0 API)

java.lang.Object
- org.eclipse.lsp4j.debug.Source

```
public class Source
extends java.lang.Object
```
A Source is a descriptor for source code. It is returned from the debug adapter as part of a StackFrame and it is used by clients when specifying breakpoints.

Constructor Summary

Constructors
Constructor and Description

Source()

Constructors
Constructor and Description
`Source()`

Method Summary

All Methods Instance Methods Concrete Methods
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()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Source
```
public Source()
```
- Method Detail
  - getName
```
@Pure
public java.lang.String getName()
```
    The short name of the source. Every source returned from the debug adapter has a name. When sending a source to the debug adapter this name is optional.
    This is an optional property.
  - setName
```
public void setName(java.lang.String name)
```
    The short name of the source. Every source returned from the debug adapter has a name. When sending a source to the debug adapter this name is optional.
    This is an optional property.
  - getPath
```
@Pure
public java.lang.String getPath()
```
    The path of the source to be shown in the UI. 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.
  - setPath
```
public void setPath(java.lang.String path)
```
    The path of the source to be shown in the UI. 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.
  - getSourceReference
```
@Pure
public java.lang.Integer getSourceReference()
```
    If sourceReference > 0 the contents of the source must be retrieved through the SourceRequest (even if a path is specified). 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.
  - setSourceReference
```
public 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). 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.
  - getPresentationHint
```
@Pure
public SourcePresentationHint getPresentationHint()
```
    An optional hint for how to present the source in the UI. 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.
  - setPresentationHint
```
public void setPresentationHint(SourcePresentationHint presentationHint)
```
    An optional hint for how to present the source in the UI. 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.
  - getOrigin
```
@Pure
public java.lang.String getOrigin()
```
    The (optional) origin of this source: possible values 'internal module', 'inlined content from source map', etc.
    This is an optional property.
  - setOrigin
```
public void setOrigin(java.lang.String origin)
```
    The (optional) origin of this source: possible values 'internal module', 'inlined content from source map', etc.
    This is an optional property.
  - getSources
```
@Pure
public Source[] getSources()
```
    An optional list of sources that are related to this source. These may be the source that generated this source.
    This is an optional property.
  - setSources
```
public void setSources(Source[] sources)
```
    An optional list of sources that are related to this source. These may be the source that generated this source.
    This is an optional property.
  - getAdapterData
```
@Pure
public java.lang.Object getAdapterData()
```
    Optional data that a debug adapter might want to loop through the client. The client should leave the data intact and persist it across sessions. The client should not interpret the data.
    This is an optional property.
  - setAdapterData
```
public void setAdapterData(java.lang.Object adapterData)
```
    Optional data that a debug adapter might want to loop through the client. The client should leave the data intact and persist it across sessions. The client should not interpret the data.
    This is an optional property.
  - getChecksums
```
@Pure
public Checksum[] getChecksums()
```
    The checksums associated with this file.
    This is an optional property.
  - setChecksums
```
public void setChecksums(Checksum[] checksums)
```
    The checksums associated with this file.
    This is an optional property.
  - toString
```
@Pure
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
@Pure
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
@Pure
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class Source

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Source

Method Detail

getName

setName

getPath

setPath

getSourceReference

setSourceReference

getPresentationHint

setPresentationHint

getOrigin

setOrigin

getSources

setSources

getAdapterData

setAdapterData

getChecksums

setChecksums

toString

equals

hashCode