Make the getSourceRoots() and getEnabledSourceRoots(ProjectScope, Language) methods accessible from the Project interface.

Author: desruisseaux

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

@@ -19,8 +19,10 @@
 package org.apache.maven.api;
 
 import java.nio.file.Path;
+import java.util.Collection;
 import java.util.List;
 import java.util.Optional;
+import java.util.stream.Stream;
 
 import org.apache.maven.api.annotations.Experimental;
 import org.apache.maven.api.annotations.Nonnull;
@@ -49,25 +51,25 @@
 public interface Project {
 
     /**
-     * Returns the project groupId.
+     * {@return the project groupId}.
      */
     @Nonnull
     String getGroupId();
 
     /**
-     * Returns the project artifactId.
+     * {@return the project artifactId}.
      */
     @Nonnull
     String getArtifactId();
 
     /**
-     * Returns the project version.
+     * {@return the project version}.
      */
     @Nonnull
     String getVersion();
 
     /**
-     * Returns the project packaging.
+     * {@return the project packaging}.
      * <p>
      * Note: unlike in legacy code, logical checks against string representing packaging (returned by this method)
      * are NOT recommended (code like {@code "pom".equals(project.getPackaging)} must be avoided). Use method
@@ -79,7 +81,7 @@ public interface Project {
     Packaging getPackaging();
 
     /**
-     * Returns the project language. It is by default determined by {@link #getPackaging()}.
+     * {@return the project language}. It is by default determined by {@link #getPackaging()}.
      *
      * @see #getPackaging()
      */
@@ -89,7 +91,7 @@ default Language getLanguage() {
     }
 
     /**
-     * Returns the project POM artifact, which is the artifact of the POM of this project. Every project have a POM
+     * {@return the project POM artifact}, which is the artifact of the POM of this project. Every project have a POM
      * artifact, even if the existence of backing POM file is NOT a requirement (i.e. for some transient projects).
      *
      * @see org.apache.maven.api.services.ArtifactManager#getPath(Artifact)
@@ -100,7 +102,7 @@ default ProducedArtifact getPomArtifact() {
     }
 
     /**
-     * Returns the project main artifact, which is the artifact produced by this project build, if applicable.
+     * {@return the project main artifact}, which is the artifact produced by this project build, if applicable.
      * This artifact MAY be absent if the project is actually not producing any main artifact (i.e. "pom" packaging).
      *
      * @see #getPackaging()
@@ -113,7 +115,7 @@ default Optional<ProducedArtifact> getMainArtifact() {
     }
 
     /**
-     * Returns the project artifacts as immutable list. Elements are the project POM artifact and the artifact
+     * {@return the project artifacts as immutable list}. Elements are the project POM artifact and the artifact
      * produced by this project build, if applicable. Hence, the returned list may have one or two elements
      * (never less than 1, never more than 2), depending on project packaging.
      * <p>
@@ -129,13 +131,15 @@ default Optional<ProducedArtifact> getMainArtifact() {
     List<ProducedArtifact> getArtifacts();
 
     /**
-     * Returns the project model.
+     * {@return the project model}.
      */
     @Nonnull
     Model getModel();
 
     /**
      * Shorthand method.
+     *
+     * @return the build element of the project model
      */
     @Nonnull
     default Build getBuild() {
@@ -170,19 +174,19 @@ default Build getBuild() {
     Path getBasedir();
 
     /**
-     * Returns the project direct dependencies (directly specified or inherited).
+     * {@return the project direct dependencies (directly specified or inherited)}.
      */
     @Nonnull
     List<DependencyCoordinates> getDependencies();
 
     /**
-     * Returns the project managed dependencies (directly specified or inherited).
+     * {@return the project managed dependencies (directly specified or inherited)}.
      */
     @Nonnull
     List<DependencyCoordinates> getManagedDependencies();
 
     /**
-     * Returns the project ID, usable as key.
+     * {@return the project ID, usable as key}.
      */
     @Nonnull
     default String getId() {
@@ -216,6 +220,7 @@ default String getId() {
      * Gets the root directory of the project, which is the parent directory
      * containing the {@code .mvn} directory or flagged with {@code root="true"}.
      *
+     * @return the root directory of the project
      * @throws IllegalStateException if the root directory could not be found
      * @see Session#getRootDirectory()
      */
@@ -234,4 +239,32 @@ default String getId() {
      */
     @Nonnull
     Optional<Project> getParent();
+
+    /**
+     * {@return all source root directories}, including the disabled ones, for all languages and scopes.
+     * For listing only the {@linkplain SourceRoot#enabled() enabled} source roots,
+     * the following code can be used:
+     *
+     * <pre>{@literal
+     * List<SourceRoot> enabledRoots = project.getSourceRoots()
+     *         .stream().filter(SourceRoot::enabled).toList();
+     * }</pre>
+     *
+     * The iteration order is the order in which the sources are declared in the POM file.
+     */
+    @Nonnull
+    Collection<SourceRoot> getSourceRoots();
+
+    /**
+     * {@return all enabled sources that provide files in the given language for the given scope}.
+     * If the given scope is {@code null}, then this method returns the enabled sources for all scopes.
+     * If the given language is {@code null}, then this method returns the enabled sources for all languages.
+     * An arbitrary number of source roots may exist for the same scope and language.
+     * It may be, for example, the case of a multi-versions project.
+     * The iteration order is the order in which the sources are declared in the POM file.
+     *
+     * @param scope the scope of the sources to return, or {@code null} for all scopes
+     * @param language the language of the sources to return, or {@code null} for all languages
+     */
+    Stream<SourceRoot> getEnabledSourceRoots(ProjectScope scope, Language language);
 }

impl/maven-core/src/main/java/org/apache/maven/internal/impl/DefaultProject.java

@@ -24,14 +24,18 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
+import java.util.stream.Stream;
 
 import org.apache.maven.RepositoryUtils;
 import org.apache.maven.api.DependencyCoordinates;
 import org.apache.maven.api.DependencyScope;
 import org.apache.maven.api.Exclusion;
+import org.apache.maven.api.Language;
 import org.apache.maven.api.Packaging;
 import org.apache.maven.api.ProducedArtifact;
 import org.apache.maven.api.Project;
+import org.apache.maven.api.ProjectScope;
+import org.apache.maven.api.SourceRoot;
 import org.apache.maven.api.Type;
 import org.apache.maven.api.VersionConstraint;
 import org.apache.maven.api.annotations.Nonnull;
@@ -122,6 +126,7 @@ public Path getPomPath() {
         return nonNull(project.getFile(), "pomPath").toPath();
     }
 
+    @Nonnull
     @Override
     public Path getBasedir() {
         return nonNull(project.getBasedir(), "basedir").toPath();
@@ -164,6 +169,18 @@ public Optional<Project> getParent() {
         return Optional.ofNullable(session.getProject(parent));
     }
 
+    @Nonnull
+    @Override
+    public Collection<SourceRoot> getSourceRoots() {
+        return project.getSourceRoots();
+    }
+
+    @Nonnull
+    @Override
+    public Stream<SourceRoot> getEnabledSourceRoots(ProjectScope scope, Language language) {
+        return project.getEnabledSourceRoots(scope, language);
+    }
+
     @Nonnull
     private DependencyCoordinates toDependency(org.apache.maven.api.model.Dependency dependency) {
         return new DependencyCoordinates() {

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

@@ -426,6 +426,7 @@ public void addTestCompileSourceRoot(String path) {
 
     /**
      * {@return all source root directories, including the disabled ones, for all languages and scopes}.
+     * The iteration order is the order in which the sources are declared in the POM file.
      * The returned collection is unmodifiable.
      *
      * @see #addSourceRoot(SourceRoot)
@@ -438,6 +439,7 @@ public Collection<SourceRoot> getSourceRoots() {
      * {@return all enabled sources that provide files in the given language for the given scope}.
      * If the given scope is {@code null}, then this method returns the enabled sources for all scopes.
      * If the given language is {@code null}, then this method returns the enabled sources for all languages.
+     * The iteration order is the order in which the sources are declared in the POM file.
      *
      * @param scope the scope of the sources to return, or {@code null} for all scopes
      * @param language the language of the sources to return, or {@code null} for all languages