Package org.graalvm.tools.lsp.server.types

Class Diagnostic

java.lang.Object

org.graalvm.tools.lsp.server.types.JSONBase

org.graalvm.tools.lsp.server.types.Diagnostic

public class Diagnostic
extends JSONBase

Represents a diagnostic, such as a compiler error or warning. Diagnostic objects are only valid in the scope of a resource.

Method Summary

Modifier and Type	Method	Description
static Diagnostic	create(Range range, String message, DiagnosticSeverity severity, Object code, String source, List<DiagnosticRelatedInformation> relatedInformation)	Creates a new Diagnostic literal.
boolean	equals(Object obj)
Object	getCode()	The diagnostic's code, which usually appear in the user interface.
String	getMessage()	The diagnostic's message.
Range	getRange()	The range at which the message applies.
List<DiagnosticRelatedInformation>	getRelatedInformation()	An array of related diagnostic information, e.g.
DiagnosticSeverity	getSeverity()	The diagnostic's severity.
String	getSource()	A human-readable string describing the source of this diagnostic, e.g.
List<DiagnosticTag>	getTags()	Additional metadata about the diagnostic.
int	hashCode()
Diagnostic	setCode(Object code)
Diagnostic	setMessage(String message)
Diagnostic	setRange(Range range)
Diagnostic	setRelatedInformation(List<DiagnosticRelatedInformation> relatedInformation)
Diagnostic	setSeverity(DiagnosticSeverity severity)
Diagnostic	setSource(String source)
Diagnostic	setTags(List<DiagnosticTag> tags)

Methods inherited from class java.lang.Object

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

Method Details

getRange

public Range getRange()

The range at which the message applies.

setRange

public Diagnostic setRange(Range range)

getSeverity

public DiagnosticSeverity getSeverity()

The diagnostic's severity. Can be omitted. If omitted it is up to the client to interpret diagnostics as error, warning, info or hint.

setSeverity

public Diagnostic setSeverity(DiagnosticSeverity severity)

getCode

public Object getCode()

The diagnostic's code, which usually appear in the user interface.

setCode

public Diagnostic setCode(Object code)

getSource

public String getSource()

A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'. It usually appears in the user interface.

setSource

public Diagnostic setSource(String source)

getMessage

public String getMessage()

The diagnostic's message. It usually appears in the user interface

setMessage

public Diagnostic setMessage(String message)

getTags

public List<DiagnosticTag> getTags()

Additional metadata about the diagnostic.

setTags

public Diagnostic setTags(List<DiagnosticTag> tags)

getRelatedInformation

public List<DiagnosticRelatedInformation> getRelatedInformation()

An array of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.

setRelatedInformation

public Diagnostic setRelatedInformation(List<DiagnosticRelatedInformation> relatedInformation)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

create

public static Diagnostic create(Range range,
 String message,
 DiagnosticSeverity severity,
 Object code,
 String source,
 List<DiagnosticRelatedInformation> relatedInformation)

Creates a new Diagnostic literal.