Skip to content

[MNG-8662] Add missing methods for removing project source roots #2205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gnodet merged 2 commits into from
Apr 2, 2025
Merged

[MNG-8662] Add missing methods for removing project source roots #2205

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48d6c62
Add missing methods for removing project source roots
gnodet Mar 31, 2025
082c893
Code style
gnodet Mar 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 56 additions & 9 deletions impl/maven-core/src/main/java/org/apache/maven/project/MavenProject.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
import org.apache.maven.api.Language;
import org.apache.maven.api.ProjectScope;
import org.apache.maven.api.SourceRoot;
import org.apache.maven.api.annotations.Nonnull;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.ArtifactUtils;
import org.apache.maven.artifact.DependencyResolutionRequiredException;
Expand Down Expand Up @@ -343,8 +344,10 @@ public void addSourceRoot(SourceRoot source) {
*
* @since 4.0.0
*/
public void addSourceRoot(ProjectScope scope, Language language, Path directory) {
directory = getBaseDirectory().resolve(directory).normalize();
public void addSourceRoot(@Nonnull ProjectScope scope, @Nonnull Language language, @Nonnull Path directory) {
directory = getBaseDirectory()
.resolve(Objects.requireNonNull(directory, "directory cannot be null"))
.normalize();
addSourceRoot(new DefaultSourceRoot(scope, language, directory));
}

Expand All @@ -360,13 +363,43 @@ public void addSourceRoot(ProjectScope scope, Language language, Path directory)
*
* @since 4.0.0
*/
public void addSourceRoot(ProjectScope scope, Language language, String directory) {
if (directory != null) {
directory = directory.trim();
if (!directory.isBlank()) {
Path path = getBaseDirectory().resolve(directory).normalize();
addSourceRoot(scope, language, path);
}
public void addSourceRoot(@Nonnull ProjectScope scope, @Nonnull Language language, @Nonnull String directory) {
directory =
Objects.requireNonNull(directory, "directory cannot be null").trim();
if (!directory.isBlank()) {
Path path = getBaseDirectory().resolve(directory).normalize();
addSourceRoot(scope, language, path);
}
}

/**
* Removes a source root from the project.
*
* @param scope the scope of the source root
* @param language the language of the source root
* @param directory the directory of the source root
*/
public void removeSourceRoot(@Nonnull ProjectScope scope, @Nonnull Language language, @Nonnull Path directory) {
Path path = getBaseDirectory()
.resolve(Objects.requireNonNull(directory, "directory cannot be null"))
.normalize();
sources.removeIf(source -> source.scope() == scope
&& source.language() == language
&& source.directory().equals(path));
}

/**
* Removes a source root from the project.
*
* @param scope the scope of the source root
* @param language the language of the source root
* @param directory the directory of the source root
*/
public void removeSourceRoot(@Nonnull ProjectScope scope, @Nonnull Language language, @Nonnull String directory) {
directory =
Objects.requireNonNull(directory, "directory cannot be null").trim();
if (!directory.isBlank()) {
removeSourceRoot(scope, language, Path.of(directory));
}
}

Expand All @@ -378,6 +411,14 @@ public void addCompileSourceRoot(String path) {
addSourceRoot(ProjectScope.MAIN, Language.JAVA_FAMILY, path);
}

/**
* @deprecated Replaced by {@code removeSourceRoot(ProjectScope.MAIN, Language.JAVA_FAMILY, path)}.
*/
@Deprecated(since = "4.0.0")
public void removeCompileSourceRoot(String path) {
removeSourceRoot(ProjectScope.MAIN, Language.JAVA_FAMILY, path);
}

/**
* @deprecated Replaced by {@code addSourceRoot(ProjectScope.TEST, Language.JAVA_FAMILY, path)}.
*/
Expand All @@ -386,6 +427,12 @@ public void addTestCompileSourceRoot(String path) {
addSourceRoot(ProjectScope.TEST, Language.JAVA_FAMILY, path);
}

/**
* @deprecated Replaced by {@code removeSourceRoot(ProjectScope.TEST, Language.JAVA_FAMILY, path)}.
*/
public void removeTestCompileSourceRoot(String path) {
removeSourceRoot(ProjectScope.TEST, Language.JAVA_FAMILY, 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.
Expand Down