Package org.apache.maven.internal.impl

Class DefaultProject

java.lang.Object

org.apache.maven.internal.impl.DefaultProject

All Implemented Interfaces:

Project

public class DefaultProject
extends Object
implements Project

Constructor Summary

Constructors

Constructor	Description
DefaultProject(AbstractSession session, MavenProject project)

Method Summary

Modifier and Type	Method	Description
Artifact	getArtifact()
String	getArtifactId()
List<DependencyCoordinate>	getDependencies()
String	getGroupId()
List<DependencyCoordinate>	getManagedDependencies()
Model	getModel()
String	getPackaging()
Optional<Project>	getParent()
Optional<Path>	getPomPath()	Returns the path to the pom file for this project.
MavenProject	getProject()
List<RemoteRepository>	getRemotePluginRepositories()
List<RemoteRepository>	getRemoteProjectRepositories()
Path	getRootDirectory()	Gets the root directory of the project, which is the parent directory containing the .mvn directory or flagged with root="true".
AbstractSession	getSession()
String	getVersion()
boolean	isExecutionRoot()
boolean	isRootProject()	Returns a boolean indicating if the project is a root project, meaning that the Project.getRootDirectory() and Project.getBasedir() points to the same directory, and that either Model.isRoot() is true or that basedir contains a .mvn child directory.
boolean	isTopProject()	Returns a boolean indicating if the project is the top level project for this reactor build.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.api.Project

getBasedir, getBuild, getId

Constructor Details

DefaultProject

public DefaultProject(AbstractSession session,
 MavenProject project)

Method Details

getSession

public AbstractSession getSession()

getProject

public MavenProject getProject()

getGroupId

@Nonnull
public String getGroupId()

Specified by:

getGroupId in interface Project

getArtifactId

@Nonnull
public String getArtifactId()

Specified by:

getArtifactId in interface Project

getVersion

@Nonnull
public String getVersion()

Specified by:

getVersion in interface Project

getArtifact

@Nonnull
public Artifact getArtifact()

Specified by:

getArtifact in interface Project

getPackaging

@Nonnull
public String getPackaging()

Specified by:

getPackaging in interface Project

getModel

@Nonnull
public Model getModel()

Specified by:

getModel in interface Project

getPomPath

@Nonnull
public Optional<Path> getPomPath()

Description copied from interface: Project

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.

Specified by:

getPomPath in interface Project

Returns:

the path of the pom

getDependencies

@Nonnull
public List<DependencyCoordinate> getDependencies()

Specified by:

getDependencies in interface Project

getManagedDependencies

@Nonnull
public List<DependencyCoordinate> getManagedDependencies()

Specified by:

getManagedDependencies in interface Project

isExecutionRoot

public boolean isExecutionRoot()

Specified by:

isExecutionRoot in interface Project

isTopProject

public boolean isTopProject()

Description copied from interface: Project

Returns a boolean indicating if the project is the top level project for this reactor build. The top level project may be different from the rootDirectory, especially if a subtree of the project is being built, either because Maven has been launched in a subdirectory or using a -f option.

Specified by:

isTopProject in interface Project

Returns:

true if the project is the top level project for this build

isRootProject

public boolean isRootProject()

Description copied from interface: Project

Returns a boolean indicating if the project is a root project, meaning that the Project.getRootDirectory() and Project.getBasedir() points to the same directory, and that either Model.isRoot() is true or that basedir contains a .mvn child directory.

Specified by:

isRootProject in interface Project

Returns:

true if the project is the root project

See Also:

• Model.isRoot()

getRootDirectory

public Path getRootDirectory()

Description copied from interface: Project

Gets the root directory of the project, which is the parent directory containing the .mvn directory or flagged with root="true".

Specified by:

getRootDirectory in interface Project

See Also:

• Session.getRootDirectory()

getParent

public Optional<Project> getParent()

Specified by:

getParent in interface Project

getRemoteProjectRepositories

public List<RemoteRepository> getRemoteProjectRepositories()

Specified by:

getRemoteProjectRepositories in interface Project

getRemotePluginRepositories

public List<RemoteRepository> getRemotePluginRepositories()

Specified by:

getRemotePluginRepositories in interface Project