Package org.apache.maven.internal.impl

Class DefaultProjectManager

java.lang.Object

org.apache.maven.internal.impl.DefaultProjectManager

All Implemented Interfaces:

Service, ProjectManager

@Named
@Typed
@SessionScoped
public class DefaultProjectManager
extends Object
implements ProjectManager

Constructor Summary

Constructors

Constructor	Description
DefaultProjectManager(InternalMavenSession session, ArtifactManager artifactManager)

Method Summary

Modifier and Type	Method	Description
void	addCompileSourceRoot(Project project, ProjectScope scope, Path sourceRoot)	Add a compilation source root to the given project for the given scope.
void	addResource(Project project, ProjectScope scope, Resource resource)	Add a resource set to the given project for the given scope.
void	attachArtifact(Project project, ProducedArtifact artifact, Path path)	Attaches a produced artifact to the project at the specified path.
Collection<ProducedArtifact>	getAllArtifacts(Project project)	Returns project's all artifacts as immutable collection.
Collection<ProducedArtifact>	getAttachedArtifacts(Project project)	Returns an immutable collection of attached artifacts for given project.
List<Path>	getCompileSourceRoots(Project project, ProjectScope scope)	Obtain an immutable list of compile source roots for the given project and scope.
Optional<Project>	getExecutionProject(Project project)
Optional<Path>	getPath(Project project)	Returns the path to the built project artifact file, if the project has been built.
Map<String,String>	getProperties(Project project)	Returns an immutable map of the project properties.
List<RemoteRepository>	getRemotePluginRepositories(Project project)	Returns an immutable list of project remote plugin repositories (directly specified or inherited).
List<RemoteRepository>	getRemoteProjectRepositories(Project project)	Returns an immutable list of project remote repositories (directly specified or inherited).
List<Resource>	getResources(Project project, ProjectScope scope)	Get the list of resources for the given project and scope
void	setProperty(Project project, String key, String value)	Set a given project property.

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.services.ProjectManager

attachArtifact, attachArtifact

Constructor Details

DefaultProjectManager

@Inject
public DefaultProjectManager(InternalMavenSession session,
 ArtifactManager artifactManager)

Method Details

getPath

@Nonnull
public Optional<Path> getPath(Project project)

Description copied from interface: ProjectManager

Returns the path to the built project artifact file, if the project has been built.

Specified by:

getPath in interface ProjectManager

Returns:

the path of the built project artifact

getAttachedArtifacts

@Nonnull
public Collection<ProducedArtifact> getAttachedArtifacts(Project project)

Description copied from interface: ProjectManager

Returns an immutable collection of attached artifacts for given project.

Specified by:

getAttachedArtifacts in interface ProjectManager

getAllArtifacts

public Collection<ProducedArtifact> getAllArtifacts(Project project)

Description copied from interface: ProjectManager

Returns project's all artifacts as immutable collection. The list contains all artifacts, even the attached ones, if any. Hence, the list returned by this method depends on which lifecycle step of the build was it invoked. The head of returned list is result of Project.getArtifacts() method, so same applies here: the list can have minimum of one element. The maximum number of elements is in turn dependent on build configuration and lifecycle phase when this method was invoked (i.e. is javadoc jar built and attached, is sources jar built attached, are all the artifact signed, etc.).

This method is shorthand for Project.getArtifacts() and ProjectManager.getAttachedArtifacts(Project) methods.

Specified by:

getAllArtifacts in interface ProjectManager

See Also:

• ArtifactManager.getPath(Artifact)

attachArtifact

public void attachArtifact(Project project,
 ProducedArtifact artifact,
 Path path)

Description copied from interface: ProjectManager

Attaches a produced artifact to the project at the specified path. This is the base method that the other attachArtifact methods delegate to.

Specified by:

attachArtifact in interface ProjectManager

Parameters:

project - the project to attach the artifact to

artifact - the produced artifact to attach

path - the path to the artifact file

getCompileSourceRoots

public List<Path> getCompileSourceRoots(Project project,
 ProjectScope scope)

Description copied from interface: ProjectManager

Obtain an immutable list of compile source roots for the given project and scope. Paths are absolute.

Specified by:

getCompileSourceRoots in interface ProjectManager

Parameters:

project - the project

scope - the scope, i.e. usually main or test

Returns:

the list of compile source roots

addCompileSourceRoot

public void addCompileSourceRoot(Project project,
 ProjectScope scope,
 Path sourceRoot)

Description copied from interface: ProjectManager

Add a compilation source root to the given project for the given scope. The path will be transformed into an absolute path and added to the list for the given scope, if not already present.

Specified by:

addCompileSourceRoot in interface ProjectManager

Parameters:

project - the project

scope - the scope, i.e. usually main or test

sourceRoot - the new source root

getResources

public List<Resource> getResources(@Nonnull
 Project project,
 @Nonnull
 ProjectScope scope)

Description copied from interface: ProjectManager

Get the list of resources for the given project and scope

Specified by:

getResources in interface ProjectManager

Parameters:

project - the project

scope - the scope, i.e. usually main or test

Returns:

the list of resources

addResource

public void addResource(@Nonnull
 Project project,
 @Nonnull
 ProjectScope scope,
 @Nonnull
 Resource resource)

Description copied from interface: ProjectManager

Add a resource set to the given project for the given scope.

Specified by:

addResource in interface ProjectManager

Parameters:

project - the project

scope - the scope, i.e. usually main or test

resource - the resource set to add

getRemoteProjectRepositories

public List<RemoteRepository> getRemoteProjectRepositories(Project project)

Description copied from interface: ProjectManager

Returns an immutable list of project remote repositories (directly specified or inherited).

Specified by:

getRemoteProjectRepositories in interface ProjectManager

Parameters:

project - the project

getRemotePluginRepositories

public List<RemoteRepository> getRemotePluginRepositories(Project project)

Description copied from interface: ProjectManager

Returns an immutable list of project remote plugin repositories (directly specified or inherited).

Specified by:

getRemotePluginRepositories in interface ProjectManager

Parameters:

project - the project

setProperty

public void setProperty(Project project,
 String key,
 String value)

Description copied from interface: ProjectManager

Set a given project property.

Specified by:

setProperty in interface ProjectManager

Parameters:

project - the project to modify

key - they property's key

value - the value or null to unset the property

getProperties

public Map<String,String> getProperties(Project project)

Description copied from interface: ProjectManager

Returns an immutable map of the project properties.

Specified by:

getProperties in interface ProjectManager

See Also:

• ProjectManager.setProperty(Project, String, String)

getExecutionProject

public Optional<Project> getExecutionProject(Project project)

Specified by:

getExecutionProject in interface ProjectManager