Project API
Official

ProjectAPI The Project API defines abstract projects, i.e.

See:
Description

Project API

org.netbeans.api.project	General API for finding and manipulating all kinds of projects.
org.netbeans.spi.project	Support for defining project types.
org.netbeans.spi.project.support

ProjectAPI The Project API defines abstract projects, i.e. groupings of files built and manipulated as units. It is used for Ant-based projects but could support other scenarios such as makefiles. Modules can plug in project types which can recognize certain folders as being projects, and define their behaviors. Besides the visible Javadoc, this module permits a project to add implementations of org.netbeans.spi.queries.FileBuiltQueryImplementation, org.netbeans.spi.queries.SharabilityQueryImplementation and org.netbeans.spi.queries.FileEncodingQueryImplementation into the project lookup (rather than global lookup). The implementations will be consulted only in the case the relevant file belongs to that project (according to org.netbeans.api.project.FileOwnerQuery). This helps avoid the need to consult irrelevant query implementations.

What is New (see all changes)?

• Jul 9 '08 Added class SingleMethod

  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.

• Jun 9 '08 Added ProjectUtils.getAuxiliaryConfiguration

  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.

• Jun 9 '08 Added ProjectUtils.getPreferences.

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

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

  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.

• Sep 8 '06 Added support for project configurations

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

Use Cases

The SPI should be used by modules defining particular project types, e.g. the J2SE project type. The API is to be used primarily by GUI infrastructure and some queries, though other module code may on occasion need to refer to the API.

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...

Group of java interfaces

Interface Name	In/Out	Stability	Specified in What Document?
ProjectAPI	Exported	Official	The Project API defines abstract projects, i.e. groupings of files built and manipulated as units. It is used for Ant-based projects but could support other scenarios such as makefiles. Modules can plug in project types which can recognize certain folders as being projects, and define their behaviors. Besides the visible Javadoc, this module permits a project to add implementations of org.netbeans.spi.queries.FileBuiltQueryImplementation, org.netbeans.spi.queries.SharabilityQueryImplementation and org.netbeans.spi.queries.FileEncodingQueryImplementation into the project lookup (rather than global lookup). The implementations will be consulted only in the case the relevant file belongs to that project (according to org.netbeans.api.project.FileOwnerQuery). This helps avoid the need to consult irrelevant query implementations.

Implementation Details

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

Nothing.

Read more about the implementation in the answers to architecture questions.