org.netbeans.api.lsp

Class Diagnostic

java.lang.Object

org.netbeans.api.lsp.Diagnostic

public class Diagnostic
extends Object

A diagnostic for LSP. Use a Diagnostic.Builder to create an instance.

Since:

1.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Diagnostic.Builder The build for the Diagnostic.
static interface	Diagnostic.LazyCodeActions Interface to compute Diagnostic's CodeActions lazily.
static interface	Diagnostic.ReporterControl Allows to trigger diagnostics collection.
static class	Diagnostic.Severity

Method Summary

Modifier and Type	Method and Description
static Diagnostic.ReporterControl	findReporterControl(Lookup context, FileObject file) Returns a Control object appropriate for the context and the file.
Diagnostic.LazyCodeActions	getActions() The actions associated with the diagnostic.
String	getCode() The code of the diagnostic.
URL	getCodeDescription() The URL where the problem is described.
String	getDescription() The description of the diagnostic.
Position	getEndPosition() The end offset of the diagnostic.
Diagnostic.Severity	getSeverity() The severity of the diagnostic.
Position	getStartPosition() The start offset of the diagnostic.

Methods inherited from class java.lang.Object

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

Method Detail

getStartPosition

public Position getStartPosition()

The start offset of the diagnostic.

Returns:

the start offset of the diagnostic

getEndPosition

public Position getEndPosition()

The end offset of the diagnostic.

Returns:

the end offset of the diagnostic

getDescription

public String getDescription()

The description of the diagnostic.

Returns:

the description of the diagnostic

getSeverity

public Diagnostic.Severity getSeverity()

The severity of the diagnostic.

Returns:

the severity of the diagnostic

getCode

public String getCode()

The code of the diagnostic.

Returns:

the code of the diagnostic

getCodeDescription

public URL getCodeDescription()

The URL where the problem is described.

Returns:

URL with problem description

getActions

public Diagnostic.LazyCodeActions getActions()

The actions associated with the diagnostic.

Returns:

the actions associated with the diagnostic

findReporterControl

public static Diagnostic.ReporterControl findReporterControl(@NullAllowed
                                                             Lookup context,
                                                             @NullAllowed
                                                             FileObject file)

Returns a Control object appropriate for the context and the file. The returned object can be used to fire changes to LSP client(s). It is important to call the method while the context is in effect, i.e. during the client's request. May return null if no suitable LSP can be found.

Parameters:

context - the Optional. Context used to identify the LSP client. If null, the default Lookup will be used.

file - Optional. The file or folder whose diagnostic will be reported.

Returns:

the control object.

Since:

1.11