Package org.apache.maven.api

Interface Project

All Known Implementing Classes:

DefaultProject

@Experimental
public interface Project

Interface representing a Maven project. Projects can be built using the ProjectBuilder service.

Since:

4.0

Method Summary

Modifier and Type	Method	Description
Artifact	getArtifact()
String	getArtifactId()
default Optional<Path>	getBasedir()
default Build	getBuild()
List<DependencyCoordinate>	getDependencies()
String	getGroupId()
default String	getId()
List<DependencyCoordinate>	getManagedDependencies()
Model	getModel()
String	getPackaging()
Optional<Project>	getParent()
Optional<Path>	getPomPath()	Returns the path to the pom file for this project.
List<RemoteRepository>	getRemotePluginRepositories()
List<RemoteRepository>	getRemoteProjectRepositories()
String	getVersion()
boolean	isExecutionRoot()

Method Details

getGroupId

@Nonnull
String getGroupId()

getArtifactId

@Nonnull
String getArtifactId()

getVersion

@Nonnull
String getVersion()

getPackaging

@Nonnull
String getPackaging()

getArtifact

@Nonnull
Artifact getArtifact()

getModel

@Nonnull
Model getModel()

getBuild

@Nonnull
default Build getBuild()

getPomPath

@Nonnull
Optional<Path> getPomPath()

Returns the path to the pom file for this project. A project is usually read from the file system and this will point to the file. In some cases, a transient project can be created which will not point to an actual pom file.

Returns:

the path of the pom

getBasedir

@Nonnull
default Optional<Path> getBasedir()

getDependencies

@Nonnull
List<DependencyCoordinate> getDependencies()

getManagedDependencies

@Nonnull
List<DependencyCoordinate> getManagedDependencies()

getId

@Nonnull
default String getId()

isExecutionRoot

boolean isExecutionRoot()

getParent

@Nonnull
Optional<Project> getParent()

getRemoteProjectRepositories

@Nonnull
List<RemoteRepository> getRemoteProjectRepositories()

getRemotePluginRepositories

@Nonnull
List<RemoteRepository> getRemotePluginRepositories()