Rename getSourceRoots(scope, language) as getEnabledSourceRoot and returns only enabled sources.

Author: desruisseaux

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

@@ -130,7 +130,7 @@ public void attachArtifact(Project project, ProducedArtifact artifact, Path path
     @Override
     public List<Path> getCompileSourceRoots(Project project, ProjectScope scope) {
         MavenProject prj = getMavenProject(nonNull(project, "project"));
-        return prj.getSourceRoots(scope, Language.JAVA_FAMILY)
+        return prj.getEnabledSourceRoots(scope, Language.JAVA_FAMILY)
                 .map(SourceRoot::directory)
                 .toList();
     }

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

@@ -23,6 +23,7 @@
 import java.io.Writer;
 import java.nio.file.Path;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.LinkedHashMap;
@@ -352,6 +353,8 @@ public DependencyManagement getDependencyManagement() {
      * @throws IllegalArgumentException if a source exists for the given language, scope and directory
      *         but with different values for the other properties.
      *
+     * @see #getSourceRoots()
+     *
      * @since 4.0.0
      */
     public void addSourceRoot(SourceRoot source) {
@@ -372,6 +375,8 @@ public void addSourceRoot(SourceRoot source) {
      * @param language language of the files contained in the directory to add
      * @param directory the directory to add if not already present in the source
      *
+     * @see #getEnabledSourceRoots(ProjectScope, Language)
+     *
      * @since 4.0.0
      */
     public void addSourceRoot(ProjectScope scope, Language language, Path directory) {
@@ -420,17 +425,29 @@ public void addTestCompileSourceRoot(String path) {
     }
 
     /**
-     * {@return all sources that provide files in the given language for the given scope}.
-     * If the given scope is {@code null}, then this method returns the sources for all scopes.
-     * If the given language is {@code null}, then this method returns the sources for all languages.
+     * {@return all source root directories, including the disabled ones, for all languages and scopes}.
+     * The returned collection is unmodifiable.
+     *
+     * @see #addSourceRoot(SourceRoot)
+     */
+    public Collection<SourceRoot> getSourceRoots() {
+        return Collections.unmodifiableCollection(sources.values());
+    }
+
+    /**
+     * {@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.
      *
      * @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
      *
+     * @see #addSourceRoot(ProjectScope, Language, Path)
+     *
      * @since 4.0.0
      */
-    public Stream<SourceRoot> getSourceRoots(ProjectScope scope, Language language) {
-        Stream<SourceRoot> s = sources.values().stream();
+    public Stream<SourceRoot> getEnabledSourceRoots(ProjectScope scope, Language language) {
+        Stream<SourceRoot> s = sources.values().stream().filter(SourceRoot::enabled);
         if (scope != null) {
             s = s.filter((source) -> scope.equals(source.scope()));
         }
@@ -447,21 +464,21 @@ public Stream<SourceRoot> getSourceRoots(ProjectScope scope, Language language)
      */
     @Deprecated
     private List<String> getSourceRootDirs(ProjectScope scope, Language language) {
-        return getSourceRoots(scope, language)
+        return getEnabledSourceRoots(scope, language)
                 .map((source) -> source.directory().toString())
                 .toList();
     }
 
     /**
-     * @deprecated Replaced by {@code getSourceRoots(ProjectScope.MAIN, Language.JAVA_FAMILY)}.
+     * @deprecated Replaced by {@code getEnabledSourceRoots(ProjectScope.MAIN, Language.JAVA_FAMILY)}.
      */
     @Deprecated(since = "4.0.0")
     public List<String> getCompileSourceRoots() {
         return getSourceRootDirs(ProjectScope.MAIN, Language.JAVA_FAMILY);
     }
 
     /**
-     * @deprecated Replaced by {@code getSourceRoots(ProjectScope.TEST, Language.JAVA_FAMILY)}.
+     * @deprecated Replaced by {@code getEnabledSourceRoots(ProjectScope.TEST, Language.JAVA_FAMILY)}.
      */
     @Deprecated(since = "4.0.0")
     public List<String> getTestCompileSourceRoots() {
@@ -747,15 +764,15 @@ public Build getBuild() {
     }
 
     /**
-     * @deprecated Replaced by {@code getSourceRoots(ProjectScope.MAIN, Language.RESOURCES)}.
+     * @deprecated Replaced by {@code getEnabledSourceRoots(ProjectScope.MAIN, Language.RESOURCES)}.
      */
     @Deprecated(since = "4.0.0")
     public List<Resource> getResources() {
         return getBuild().getResources();
     }
 
     /**
-     * @deprecated Replaced by {@code getSourceRoots(ProjectScope.TEST, Language.RESOURCES)}.
+     * @deprecated Replaced by {@code getEnabledSourceRoots(ProjectScope.TEST, Language.RESOURCES)}.
      */
     @Deprecated(since = "4.0.0")
     public List<Resource> getTestResources() {