Package org.netbeans.spi.project
package org.netbeans.spi.project
Support for defining project types.
Each kind of project in the system needs to be loaded by a
ProjectFactory
, which defines how to recognize
projects on disk, load their metadata into memory, and save their metadata back
to disk. ProjectState
is used to let the
factory mark a project as being modified in memory.
Projects will normally put implementations of several interfaces such as
ActionProvider
into their lookup.
-
ClassDescriptionPermits the invoker of an action to follow its progress.Ability for a project to have various actions (e.g.Ability for a project to permit other modules to insert arbitrary metadata into the project storage area.Allow to store arbitrary properties in the project, similarly as
AuxiliaryConfiguration
.Ability for a project to permit other modules to store arbitrary cache data associated with the project.Project Copy Operation.Base for various Project Operations, allows to gather metadata and data files for a project.Project Delete Operation.This is a less vague variant of theSubprojectProvider
for code that wants to access project's dependencies that are also projects.non mutable result objectKnowledge of which project some files belong to.LookupMerger<T>Allows project lookup to merge instances of known classes and replace them with single instance.Registers a lookup merger for some project types.interface for inclusion of 3rd party content in project's lookup.Annotation to registerLookupProvider
instances.Project Rename/Move Operation.A preferred substitute forMoveOperationImplementation
to be used when the project can behave more simply, efficiently, and robustly when it is simply being renamed (code and/or display name) without actually being moved to a new location.Structure representing an identification of a nested class in a file.Optional ability of a project to determine its immediate parent project, if there is any.Represents one user-selectable configuration of a particular project.ProjectConfigurationProvider<C extends ProjectConfiguration>Provider of configurations for a project.This is a less vague variant of theSubprojectProvider
for code that wants to access projects that the current project serves as container for.non mutable result objectCreate in-memory projects from disk directories.Create in-memory projects from disk directories.Permits third parties to alter a project's icon.The SPI class forProjectManager
.Callback to notify theProjectManager
about changes.LikeLookupProvider
but registers a single object into a project's lookup.Callback permittingProject
s to inform theProjectManager
of important lifecycle events.Optional ability of a project to determine its root project (farthest parent), or return self if it is a root project by itself.Structure representing an identification of a single method/function in a file.The SPI side ofSourceGroupModifier
.Intermediate level for more structured projects, where the simple type-based information are not sufficient to create an appropriate folder structure.Optional ability of projects which may have a list of "subprojects".