Package org.apache.maven.project

Class DefaultProjectBuilder

java.lang.Object

org.apache.maven.project.DefaultProjectBuilder

All Implemented Interfaces:

ProjectBuilder

@Component(role=ProjectBuilder.class)
public class DefaultProjectBuilder
extends java.lang.Object
implements ProjectBuilder

DefaultProjectBuilder

Constructor Summary

Constructors

Constructor	Description
DefaultProjectBuilder()

Method Summary

Modifier and Type	Method	Description
ProjectBuildingResult	build(java.io.File pomFile, ProjectBuildingRequest request)	Builds a project descriptor from the specified POM file.
java.util.List<ProjectBuildingResult>	build(java.util.List<java.io.File> pomFiles, boolean recursive, ProjectBuildingRequest request)	Builds the projects for the specified POM files and optionally their children.
ProjectBuildingResult	build(org.apache.maven.artifact.Artifact artifact, boolean allowStubModel, ProjectBuildingRequest request)	Builds a project descriptor for the specified artifact.
ProjectBuildingResult	build(org.apache.maven.artifact.Artifact artifact, ProjectBuildingRequest request)	Builds a project descriptor for the specified artifact.
ProjectBuildingResult	build(org.apache.maven.model.building.ModelSource modelSource, ProjectBuildingRequest request)	Builds a project descriptor for the specified model source.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultProjectBuilder

public DefaultProjectBuilder()

Method Detail

build

public ProjectBuildingResult build(java.io.File pomFile,
                                   ProjectBuildingRequest request)
                            throws ProjectBuildingException

Description copied from interface: ProjectBuilder

Builds a project descriptor from the specified POM file.

Specified by:

build in interface ProjectBuilder

Parameters:

pomFile - The POM file to build the project from, must not be null.

request - The project building request that holds further parameters, must not be null.

Returns:

The result of the project building, never null.

Throws:

ProjectBuildingException - If the project descriptor could not be successfully built.

build

public ProjectBuildingResult build(org.apache.maven.model.building.ModelSource modelSource,
                                   ProjectBuildingRequest request)
                            throws ProjectBuildingException

Description copied from interface: ProjectBuilder

Builds a project descriptor for the specified model source.

Specified by:

build in interface ProjectBuilder

Parameters:

modelSource - The source of the model to built the project descriptor from, must not be null.

request - The project building request that holds further parameters, must not be null.

Returns:

The result of the project building, never null.

Throws:

ProjectBuildingException - If the project descriptor could not be successfully built.

See Also:

ModelSource2

build

public ProjectBuildingResult build(org.apache.maven.artifact.Artifact artifact,
                                   ProjectBuildingRequest request)
                            throws ProjectBuildingException

Description copied from interface: ProjectBuilder

Builds a project descriptor for the specified artifact.

Specified by:

build in interface ProjectBuilder

Parameters:

artifact - The POM artifact to build the project from, must not be null.

request - The project building request that holds further parameters, must not be null.

Returns:

The result of the project building, never null.

Throws:

ProjectBuildingException - If the project descriptor could not be successfully built.

build

public ProjectBuildingResult build(org.apache.maven.artifact.Artifact artifact,
                                   boolean allowStubModel,
                                   ProjectBuildingRequest request)
                            throws ProjectBuildingException

Description copied from interface: ProjectBuilder

Builds a project descriptor for the specified artifact.

Specified by:

build in interface ProjectBuilder

Parameters:

artifact - The POM artifact to build the project from, must not be null.

allowStubModel - A flag controlling the case of a missing POM artifact. If true and the specified POM artifact does not exist, a simple stub model will be returned. If false, an exception will be thrown.

request - The project building request that holds further parameters, must not be null.

Returns:

The result of the project building, never null.

Throws:

ProjectBuildingException - If the project descriptor could not be successfully built.

build

public java.util.List<ProjectBuildingResult> build(java.util.List<java.io.File> pomFiles,
                                                   boolean recursive,
                                                   ProjectBuildingRequest request)
                                            throws ProjectBuildingException

Description copied from interface: ProjectBuilder

Builds the projects for the specified POM files and optionally their children.

Specified by:

build in interface ProjectBuilder

Parameters:

pomFiles - The POM files to build, must not be null.

recursive - true to recursively build sub modules referenced by the POM files, false to build only the specified POM files.

request - The project builder configuration that provides further parameters, must not be null.

Returns:

The results of the project builder where each result corresponds to one project that was built, never null.

Throws:

ProjectBuildingException - If an error was encountered during building of any project. ProjectBuildingException.getResults() provides access to the details of the problems.