Project API
Official

ProjectAPI The Project API defines abstract projects.

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. These are 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)?

• Nov 15 '11 SourceGroup.contains no longer throws IllegalArgumentException

  For convenience and safety, the contains method no longer throws an unchecked exception; it proved infeasible to ensure the precondition even in the face of projects being renamed or deleted or similar dynamic changes to directory structure.

• Sep 10 '11 Added LookupProviderSupport.createActionProviderMerger factory method

  Added LookupProviderSupport.createActionProviderMerger factory method to create a LookupMerger for merging multiple instances of ActionProvider in the project's Lookup.

• Jun 24 '10 Added ProjectIconAnnotator

  A mechanism for changing the project node icon. You can use it for example to add a badge to the project's icon.

• Apr 15 '10 Added MoveOrRenameOperationImplementation

  Extended interface giving projects the ability to implement a simple display name change more safely and efficiently.

• Jul 21 '09 API complement to CacheDirectoryProvider

  Added ProjectUtils.getCacheDirectory to complement the SPI interface CacheDirectoryProvider.

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. These are 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.