org.apache.maven.api.services

Interface ProjectBuilderResult

@Experimental
public interface ProjectBuilderResult

Result of a project build call.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
Optional<DependencyCollectorResult>	getDependencyResolverResult() Gets the result of the dependency resolution for the project.
Optional<Path>	getPomFile() Gets the POM file from which the project was built.
Collection<ProjectBuilderProblem>	getProblems() Gets the problems that were encountered during the project building.
Optional<Project>	getProject() Gets the project that was built.
String	getProjectId() Gets the identifier of the project that could not be built.

Method Detail

getProjectId

@Nonnull
String getProjectId()

Gets the identifier of the project that could not be built. The general format of the identifier is <groupId>:<artifactId>:<version> but some of these coordinates may still be unknown at the point the exception is thrown so this information is merely meant to assist the user.

Returns:

The identifier of the project or an empty string if not known, never null.

getPomFile

@Nonnull
Optional<Path> getPomFile()

Gets the POM file from which the project was built.

Returns:

The optional POM file.

getProject

@Nonnull
Optional<Project> getProject()

Gets the project that was built.

Returns:

The project that was built or null if an error occurred and this result accompanies a ProjectBuilderException.

getProblems

@Nonnull
Collection<ProjectBuilderProblem> getProblems()

Gets the problems that were encountered during the project building.

Returns:

The problems that were encountered during the project building, can be empty but never null.

getDependencyResolverResult

@Nonnull
Optional<DependencyCollectorResult> getDependencyResolverResult()

Gets the result of the dependency resolution for the project.

Returns:

The result of the dependency resolution for the project.