Introduction

This document lists changes made to the Project API.

Index of APIs

Project API

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

(Nov 13 '08) Add annotation @LookupProvider.Registration
(Jul 9 '08) Added class SingleMethod
(Jun 9 '08) Added ProjectUtils.getAuxiliaryConfiguration
(Jun 9 '08) Added ProjectUtils.getPreferences.
(Oct 5 '06) Added support for composing project's lookup from multiple sources.
(Sep 8 '06) Added support for project configurations
(Aug 22 '05) Added support for project delete/copy/rename/move
(May 27 '05) The FileOwnerQuery.markExternalOwner allows registration of individal files and URIs
(Dec 22 '04) Switched to major release version 1

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.modules.projectapi/1 > 1.20

(1.21) Add annotation @LookupProvider.Registration
(1.19) Added class SingleMethod
(1.17) Added ProjectUtils.getAuxiliaryConfiguration
(1.16) Added ProjectUtils.getPreferences.
(1.12) Added support for composing project's lookup from multiple sources.
(1.11) Added support for project configurations
(1.7) Added support for project delete/copy/rename/move
(1.5) The FileOwnerQuery.markExternalOwner allows registration of individal files and URIs
(1.3) Switched to major release version 1

Changes by affected class

`org.netbeans.spi.project.AuxiliaryProperties`

(Jun 9 '08) Added ProjectUtils.getPreferences.

`org.netbeans.spi.project.LookupMerger`

(Oct 5 '06) Added support for composing project's lookup from multiple sources.

`org.netbeans.spi.project.LookupProvider`

(Nov 13 '08) Add annotation @LookupProvider.Registration
(Oct 5 '06) Added support for composing project's lookup from multiple sources.

`org.netbeans.spi.project.support.LookupProviderSupport`

(Oct 5 '06) Added support for composing project's lookup from multiple sources.

`org.netbeans.spi.project.ProjectConfiguration`

(Sep 8 '06) Added support for project configurations

`org.netbeans.spi.project.ProjectConfigurationProvider`

(Sep 8 '06) Added support for project configurations

`org.netbeans.api.project.ProjectUtils`

(Jun 9 '08) Added ProjectUtils.getAuxiliaryConfiguration
(Jun 9 '08) Added ProjectUtils.getPreferences.

`org.netbeans.spi.project.SingleMethod`

(Jul 9 '08) Added class SingleMethod

Details of all changes by API and date

Project API

Add annotation @LookupProvider.Registration

Nov 13 '08; API spec. version: 1.21; affected top-level classes: LookupProvider; made by: mkleint; issues: #152392

Add annotation @LookupProvider.Registration to replace registration in layer files.

Added class `SingleMethod`

Jul 9 '08; API spec. version: 1.19; affected top-level classes: SingleMethod; made by: mpetras; issues: #137191

Added class SingleMethod, which represents identification of a single method/function in a file. The new class also contains new constants (COMMAND_RUN_SINGLE_TEST_METHOD and COMMAND_DEBUG_SINGLE_TEST_METHOD) corresponding to commands for running debugging test methods.

Added `ProjectUtils.getAuxiliaryConfiguration`

Jun 9 '08; API spec. version: 1.17; affected top-level classes: ProjectUtils; made by: jglick; issues: #136333

A new API method was introduced to match the AuxiliaryConfiguration SPI interface. The change simplifies caller code, provides a path for future changes in the SPI, and allows project types to avoid providing an explicit implementation of this SPI if the fallback implementation suffices for their needs.

Compatibility:

Modules which formerly looked for AuxiliaryConfiguration directly in project lookup are strongly encouraged to migrate to the new method instead.

Added ProjectUtils.getPreferences.

Jun 9 '08; API spec. version: 1.16; affected top-level classes: ProjectUtils AuxiliaryProperties; made by: jlahoda; issues: #134580

Added new API method ProjectUtils.getPreferences and new SPI interface AuxiliaryProperties.

Compatibility:

Added support for composing project's lookup from multiple sources.

Oct 5 '06; API spec. version: 1.12; affected top-level classes: LookupProvider LookupMerger LookupProviderSupport; made by: mkleint; issues: #83343

Added interfaces and support classes that can be used to compose the project's lookup from multiple 3rd party sources. Framework for creating merged instances included. LookupMerger implementation for Sources added.

Compatibility:

Added support for project configurations

Sep 8 '06; API spec. version: 1.11; affected top-level classes: ProjectConfiguration ProjectConfigurationProvider; made by: jglick; issues: #49652

Added an interface ProjectConfigurationProvider which can be included in a project's lookup to support switchable configurations / profiles.

Added support for project delete/copy/rename/move

Aug 22 '05; API spec. version: 1.7; made by: jlahoda; issues: #61546

Introduced: New method notifyDeleted added to ProjectState. Interfaces DataFilesProviderImplementation, DeleteOperationImplementation, CopyOperationImplementation, MoveOperationImplementation has been added to support project delete/copy/rename/move. Support class ProjectOperations has been added to simplify operations on compound projects.

Compatibility:

The FileOwnerQuery.markExternalOwner allows registration of individal files and URIs

May 27 '05; API spec. version: 1.5; made by: jlahoda; issues: #58313

It is possible to register owner of an individual file using FileOwnerQuery.markExternalOwner. It is possible to register owner of a folder or file using URI, so the folder or file does not have to exist at the time of registration.

Compatibility:

This changes add a new method FileOwnerQuery.markExternalOwner(URI, FileObject, int), and also extends sematics of the existing FileOwnerQuery.markExternalOwner(FileObject, FileObject, int) method to allow registration of individual files.

Switched to major release version 1

Dec 22 '04; API spec. version: 1.3; made by: jglick; issues: #51468

To indicate that this is now considered a stable API, the major release version was incremented to 1 from 0.

Compatibility:

Clients should begin requesting the new version to avoid a warning at startup.