[MNG-8395] Redirect the <sourceDirectory> element to <Source> #2061

desruisseaux · 2025-01-26T17:44:30Z

Notable changes:

Add a SourceRoot interface for the properties declared in the POM's <Source> element.
In the POM, deprecate the sourceDirectory, testSourceDirectory, scriptSourceDirectory, resources, testResources elements and the Resource structure. They are replaced by <source> elements.
In the MavenProject class, replace the compileSourceRoots, testCompileSourceRoots and scriptSourceRoots fields by redirections to the new sources field with paths wrapped in SourceRoot objects. The resource fields are not completely replaced, information are duplicated.
The getters and setters methods for above-cited fields are deprecated.
This commit contains other opportunistic deprecations on methods which were receiving or returning instances of types that were already deprecated.

In the POM file, the above-cited deprecated properties are ignored if a corresponding <source> element exists. For example, if there is a source with <scope>main</scope> and <lang>java</lang>, then <sourceDirectory> is ignored. This rule exits because Maven sets default values to those fields, which can interfere with user's setting.

Note: the SourceRoot API uses method names without the get prefix in anticipation for possible use of records in the future.

… `<Source>` element. The API use method names without `get` prefix in anticipation for possible use of records in the future. In the `MavenProject` class, the `compileSourceRoots`, `testCompileSourceRoots` and `scriptSourceRoots` fields are replaced by redirections to the new `sources` field with paths wrapped in `SourceRoot` objects. The getters and setters methods for the previous fields are deprecated. This commit contains other opportunistic deprecations on methods working with deprecated interfaces. In the POM file, the above-cited properties are ignored if a corresponding `<Source>` element exists. This rule exits because Maven sets default values to those fields, which can interfer with user's setting.

api/maven-api-model/src/main/mdo/maven.mdo

gnodet

Javadoc fixes

gnodet

Add a @Deprecated annotation.

api/maven-api-model/src/main/mdo/maven.mdo

…n the documentation.

…d returns only enabled sources.

impl/maven-core/src/main/java/org/apache/maven/project/MavenProject.java

…Language)` methods accessible from the `Project` interface.

api/maven-api-core/src/main/java/org/apache/maven/api/Project.java

- Add `addSourceRoot(Project, …)` methods. - Deprecate `get/addResource(Project, …)` methods. - Deprecate `get/addCompileSourceRoots(Project, …)` methods.

This is done in a separated commit in case we need to revert.

gnodet · 2025-01-28T21:47:23Z

I think we also need to move the Project#getSourceRoots() and Project#getEnabledSourceRoots(ProjectScope,Language) to ProjectManager as they return values that are not meant to be immutable (as they can change by adding sources). I know from an implementation POV, they are still managed by the underlying MavenProject itself, but the idea would be to get rid of the underlying Maven 3 layer in the future.

gnodet · 2025-01-30T07:50:00Z

Thx, a few minor changes in Geomatys#1
At some point, it would be nice to have an IT that would use the new source element, as this is supposed to work even with the current set of plugins I think.

On the ProjectManager interface, Intellij warns me about overridden parameters not being annotated

desruisseaux · 2025-04-09T08:03:25Z

At some point, it would be nice to have an IT that would use the new source element

Test added in pull request 320 of compiler plugin (commit).

jira-importer · 2025-07-07T09:11:47Z

Resolve #9458

desruisseaux added 3 commits January 26, 2025 15:38

Include the list of <Source> elements in the path translation.

67dd58d

Deprecate POM elements that are replaced by <Source> elements.

77326a7