All Classes

Introduction

This document lists changes made to the LSP APIs. Please ask on the dev@netbeans.apache.org mailing list if you have any questions about the details of a change, or are wondering how to convert existing code to be compatible.

Index of APIs

LSP APIs

Incompatible changes by date

Fuller descriptions of all changes can be found below (follow links).

Not all deprecations are listed here, assuming that the deprecated APIs continue to essentially work. For a full deprecation list, please consult the Javadoc.

All changes by date

(Jan 2 '24) Added Completion.getLabelDetail() and Completion.getLabelDescription() methods.
(Dec 14 '23) Adding ErrorProvider.Context.getHintsConfigFile() method
(Dec 1 '23) Added CodeActionProvider interface
(Nov 30 '23) Added CommandProvider interface
(Sep 21 '23) Added SignatureInformation and SignatureInformationCollector
(Jul 17 '23) Added CodeAction with lazy edit computation
(May 23 '23) Added Completion.getCommand() to get an optional command
(Aug 3 '22) Added URL to diagnostic code description
(Jul 2 '22) Added CodeLensProvider and relevant elements
(May 30 '22) Added DiagnosticReporter to trigger diagnostic collection
(Mar 9 '22) Added CallHierarchyProvider and relevant elements
(Jan 24 '22) Adding StructeProvider and StructureElement
(Jun 21 '21) Adding ErrorProvider.Context.getOffset() method
(Jun 10 '21) Adding ErrorProvider
(May 13 '21) Adding Hover and HoverProvider
(May 5 '21) Adding HyperlinkTypeDefLocationProvider

Changes by version

These API specification versions may be used to indicate that a module requires a certain API feature in order to function. For example, if you see here a feature you need which is labelled 1.20, your manifest should contain in its main attributes the line:

OpenIDE-Module-Module-Dependencies: org.netbeans.api.lsp/1 > 1.20

(1.25) Adding ErrorProvider.Context.getHintsConfigFile() method
(1.24) Added Completion.getLabelDetail() and Completion.getLabelDescription() methods.
(1.23) Added CodeActionProvider interface
(1.22) Added CommandProvider interface
(1.20) Added SignatureInformation and SignatureInformationCollector
(1.18) Added CodeAction with lazy edit computation
(1.17) Added Completion.getCommand() to get an optional command
(1.12) Added URL to diagnostic code description
(1.12) Added CodeLensProvider and relevant elements
(1.11) Added DiagnosticReporter to trigger diagnostic collection
(1.9) Added CallHierarchyProvider and relevant elements
(1.8) Adding StructeProvider and StructureElement
(1.4) Adding ErrorProvider.Context.getOffset() method
(1.3) Adding ErrorProvider
(1.2) Adding Hover and HoverProvider
(1.1) Adding HyperlinkTypeDefLocationProvider

Changes by affected class

`org.netbeans.api.lsp.CallHierarchyEntry`

(Mar 9 '22) Added CallHierarchyProvider and relevant elements

`org.netbeans.spi.lsp.CallHierarchyProvider`

(Mar 9 '22) Added CallHierarchyProvider and relevant elements

`org.netbeans.api.lsp.CodeAction`

(Dec 1 '23) Added CodeActionProvider interface

`org.netbeans.spi.lsp.CodeActionProvider`

(Dec 1 '23) Added CodeActionProvider interface

`org.netbeans.api.lsp.CodeLens`

(Jul 2 '22) Added CodeLensProvider and relevant elements

`org.netbeans.spi.lsp.CodeLensProvider`

(Jul 2 '22) Added CodeLensProvider and relevant elements

`org.netbeans.spi.lsp.CommandProvider`

(Nov 30 '23) Added CommandProvider interface

`org.netbeans.api.lsp.Completion`

(Jan 2 '24) Added Completion.getLabelDetail() and Completion.getLabelDescription() methods.
(May 23 '23) Added Completion.getCommand() to get an optional command

`org.netbeans.spi.lsp.CompletionCollector`

(Jan 2 '24) Added Completion.getLabelDetail() and Completion.getLabelDescription() methods.

`org.netbeans.api.lsp.Diagnostic`

(Aug 3 '22) Added URL to diagnostic code description
(May 30 '22) Added DiagnosticReporter to trigger diagnostic collection

`org.netbeans.spi.lsp.DiagnosticReporter`

(May 30 '22) Added DiagnosticReporter to trigger diagnostic collection

`org.netbeans.spi.lsp.ErrorProvider`

(Dec 14 '23) Adding ErrorProvider.Context.getHintsConfigFile() method
(Jun 21 '21) Adding ErrorProvider.Context.getOffset() method
(Jun 10 '21) Adding ErrorProvider

`org.netbeans.api.lsp.Hover`

(May 13 '21) Adding Hover and HoverProvider

`org.netbeans.spi.lsp.HoverProvider`

(May 13 '21) Adding Hover and HoverProvider

`org.netbeans.spi.lsp.HyperlinkTypeDefLocationProvider`

(May 5 '21) Adding HyperlinkTypeDefLocationProvider

`org.netbeans.api.lsp.LazyCodeAction`

(Dec 1 '23) Added CodeActionProvider interface
(Jul 17 '23) Added CodeAction with lazy edit computation

`org.netbeans.api.lsp.SignatureInformation`

(Sep 21 '23) Added SignatureInformation and SignatureInformationCollector

`org.netbeans.spi.lsp.SignatureInformationCollector`

(Sep 21 '23) Added SignatureInformation and SignatureInformationCollector

`org.netbeans.api.lsp.StructureElement`

(Jan 24 '22) Adding StructeProvider and StructureElement

`org.netbeans.spi.lsp.StructureProvider`

(Jan 24 '22) Adding StructeProvider and StructureElement

Details of all changes by API and date

LSP APIs

Added Completion.getLabelDetail() and Completion.getLabelDescription() methods.

Jan 2 '24; API spec. version: 1.24; affected top-level classes: Completion CompletionCollector; made by: dbalek
Completion.getLabelDetail() to get an optional string describing function signatures or type annotations. Completion.getLabelDescription() to get an optional string describing fully qualified names or file path.

Adding ErrorProvider.Context.getHintsConfigFile() method

Dec 14 '23; API spec. version: 1.25; affected top-level classes: ErrorProvider; made by: Achal1607
An ErrorProvider.Context.getHintsConfigFile() method introduced that allows to get hints preference file config.

Added CodeActionProvider interface

Dec 1 '23; API spec. version: 1.23; affected top-level classes: CodeAction LazyCodeAction CodeActionProvider; made by: dbalek
CodeActionProvider has been added to allow server provide arbitrary code actions for a given document and range.

Added CommandProvider interface

Nov 30 '23; API spec. version: 1.22; affected top-level classes: CommandProvider; made by: jlahoda
CommandProvider has been added to allow server provide arbitrary commands runnable from a client.

Added SignatureInformation and SignatureInformationCollector

Sep 21 '23; API spec. version: 1.20; affected top-level classes: SignatureInformation SignatureInformationCollector; made by: dbalek
A SignatureInformation class and SignatureInformationCollector interface introduced that allows to compute and collect signature information.

Added CodeAction with lazy edit computation

Jul 17 '23; API spec. version: 1.18; affected top-level classes: LazyCodeAction; made by: dbalek
LazyCodeAction allows for lazy edit computation.

Added Completion.getCommand() to get an optional command

May 23 '23; API spec. version: 1.17; affected top-level classes: Completion; made by: dbalek
Completion.getCommand() to get an optional command that is executed after inserting the completion.

Added URL to diagnostic code description

Aug 3 '22; API spec. version: 1.12; affected top-level classes: Diagnostic; made by: sdedic
Diagnostic can link to the details of the error code using URL.

Added CodeLensProvider and relevant elements

Jul 2 '22; API spec. version: 1.12; affected top-level classes: CodeLens CodeLensProvider; made by: jlahoda
CodeLensProvider SPI allows to provide code lens for a given document.

Added DiagnosticReporter to trigger diagnostic collection

May 30 '22; API spec. version: 1.11; affected top-level classes: Diagnostic DiagnosticReporter; made by: sdedic
DiagnosticReporter SPI should be implemented to allow alerting the LSP server core that diagnostics for certain file(s) may have changed. The core implementation should then poll ErrorProviders to collect the diagnostics. API clients should call Diagnostic.findReporterControl to obtain an accessor which can fire the alert.

Added CallHierarchyProvider and relevant elements

Mar 9 '22; API spec. version: 1.9; affected top-level classes: CallHierarchyEntry CallHierarchyProvider; made by: sdedic
CallHierarchyProvider SPI allows to trace incoming and outgoing calls. CallHierarchyEntry describes a specific call site or target.

Adding StructeProvider and StructureElement

Jan 24 '22; API spec. version: 1.8; affected top-level classes: StructureElement StructureProvider; made by: ppisl
A StructureProvider interface allows to compute structure (tree of SourceElements) of the given file.

Adding ErrorProvider.Context.getOffset() method

Jun 21 '21; API spec. version: 1.4; affected top-level classes: ErrorProvider; made by: balek
An ErrorProvider.Context.getOffset() method introduced that allows to compute hint for a given file offset.

Adding ErrorProvider

Jun 10 '21; API spec. version: 1.3; affected top-level classes: ErrorProvider; made by: jlahoda
An ErrorProvider interface introduced that allows to compute errors/warnings for a given file.

Adding Hover and HoverProvider

May 13 '21; API spec. version: 1.2; affected top-level classes: Hover HoverProvider; made by: dbalek
A Hover class and HoverProvider interface introduced that allows to resolve a hover information at a given document offset and return its content.

Adding HyperlinkTypeDefLocationProvider

May 5 '21; API spec. version: 1.1; affected top-level classes: HyperlinkTypeDefLocationProvider; made by: dbalek
A HyperlinkTypeDefLocationProvider interface introduced that allows to compute hyperlinks to type definition locations.