All Classes

Introduction

This document lists changes made to the Maven Project API.

Index of APIs

Maven 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.

(Feb 10 '21) RunConfig provides access to action lookup for parameters extensibility

All changes by date

(Dec 6 '23) Allow extensions to declare run-like goals
(Oct 3 '23) Support for partially loaded projects
(Jan 23 '23)
(Sep 9 '22) LifecycleParticipants can be ignored
(Aug 10 '22) Project model can be customized for specific action or usage
(Sep 24 '21) Added helper method to get artifact paths from build plugin configurations.
(Jun 24 '21) Plugin-dependent Lookup
(May 15 '21) Plugin-dependent Lookup
(Apr 1 '21) Default for frequency of indexing
(Feb 10 '21) Allow project services, that are ordered after specific packaging type
(Feb 10 '21) RunConfig provides access to action lookup for parameters extensibility
(Feb 10 '21) Allow to extend or override parameters for user execution from action caller
(Oct 12 '20) Default for reusing tabs and compile on save
(Dec 8 '17) Attach to Debugger on triggers
(Mar 10 '15) Attach to Debugger after Goal Execution
(Jul 15 '14) nbactions.xml supports profiles section

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

(2.162) Support for partially loaded projects
(2.161) Allow extensions to declare run-like goals
(2.157)
(2.156) LifecycleParticipants can be ignored
(2.155) Project model can be customized for specific action or usage
(2.151) Added helper method to get artifact paths from build plugin configurations.
(2.149) Plugin-dependent Lookup
(2.148) Plugin-dependent Lookup
(2.147) Default for frequency of indexing
(2.144) Allow project services, that are ordered after specific packaging type
(2.144) RunConfig provides access to action lookup for parameters extensibility
(2.144) Allow to extend or override parameters for user execution from action caller
(2.141) Default for reusing tabs and compile on save
(2.127) Attach to Debugger on triggers
(2.113) Attach to Debugger after Goal Execution
(2.107) nbactions.xml supports profiles section

Changes by affected class

`org.netbeans.modules.maven.execute.ActionToGoalUtils`

(Jun 24 '21) Plugin-dependent Lookup

`org.netbeans.modules.maven.api.Constants`

(Dec 8 '17) Attach to Debugger on triggers
(Mar 10 '15) Attach to Debugger after Goal Execution

`org.netbeans.modules.maven.api.NbMavenProject`

(Oct 3 '23) Support for partially loaded projects
(Aug 10 '22) Project model can be customized for specific action or usage

`org.netbeans.modules.maven.api.execute.RunConfig`

(Feb 10 '21) RunConfig provides access to action lookup for parameters extensibility

`org.netbeans.modules.maven.api.execute.RunUtils`

(Jan 23 '23)

Details of all changes by API and date

Maven Project API

Allow extensions to declare run-like goals

Dec 6 '23; API spec. version: 2.161; made by: sdedic

The GUI recognizes user modifications to actions and refuses to configure a modified "run" action with vm and app arguments. It is now possible for a plugin to register an alternative goal, which is recognized as "exec"-like one and does not disable the GUI.

For an example, see MavenActionProvider.

Support for partially loaded projects

Oct 3 '23; API spec. version: 2.162; affected top-level classes: NbMavenProject; made by: sdedic
Added a getPartialProject that returns potentially incompletely loaded project instead of a mocked-up fallback (see isErrorPlaceholder(). Also added a isIncomplete() check that checks project's status.

Jan 23 '23; API spec. version: 2.157; affected top-level classes: RunUtils; made by: sdedic
Added a RunUtils.createRunConfig() variant that allows to create a RunConfig for a project-defined action. Clients can use this function to use all user customizations that may have been configured for the project action before executing it using RunUtils.run.

LifecycleParticipants can be ignored

Sep 9 '22; API spec. version: 2.156; made by: sdedic
NetBeans warns if a project / plugin provides AbstractLifecycleParticipants that can reconfigure the project after load. Now some harmless ones can be whitelisted so they do not produce warning / project problem. See LifecycleParticipants.

Project model can be customized for specific action or usage

Aug 10 '22; API spec. version: 2.155; affected top-level classes: NbMavenProject; made by: sdedic
Project state can be inspected with respect to an intended action to be run or used, and possible customized properties or profiles. This allows clients to more precisely follow customizations in the project file and/or action mapping that would be applied when actually using project actions.

Added helper method to get artifact paths from build plugin configurations.

Sep 24 '21; API spec. version: 2.151; made by: sdedic
In addition to String property values, or String lists, artifact-based paths, that are convertible to files, are sometimes present in plugin configuration. The new helper function getPluginPathProperty resolves a list of artifacts from the POM configuration and reports errors encountered.

Plugin-dependent Lookup

Jun 24 '21; API spec. version: 2.149; affected top-level classes: ActionToGoalUtils; made by: sdedic

Actions can be disabled by the MavenActionsProvider for a configuration.

Plugin-dependent Lookup

May 15 '21; API spec. version: 2.148; made by: sdedic

Default for frequency of indexing

Apr 1 '21; API spec. version: 2.147; made by: jtulach

Introducing branding APIs specify default frequency for downloading Maven index.

Allow project services, that are ordered after specific packaging type

Feb 10 '21; API spec. version: 2.144; made by: sdedic

Project lookup consists of base services, plus services for the project's packaging type. This change allows for generic post-processing after packaging-specific service. See MavenPackagingLookup for more details.

RunConfig provides access to action lookup for parameters extensibility

Feb 10 '21; API spec. version: 2.144; affected top-level classes: RunConfig; made by: sdedic

RunConfig now serves the originating action's context Lookup from RunConfig.getActionContext() so that the caller can pass extended one-time configuration for the action.

Binary-compatible

Allow to extend or override parameters for user execution from action caller

Feb 10 '21; API spec. version: 2.144; made by: sdedic
Added support for ExplicitProcessParameters for Maven-nature projects. The ExternaProcessParameterss instructions now append to or replace VM argsuments or user program arguments. See MavenCommandLineExecutor for more details.