Package org.apache.maven.model.building

Interface ModelBuilder

All Known Implementing Classes:

DefaultModelBuilder

public interface ModelBuilder

Builds the effective model from a POM.

Author:

Benjamin Bentmann

Method Summary

Modifier and Type	Method	Description
ModelBuildingResult	build(ModelBuildingRequest request)	Builds the effective model of the specified POM.
ModelBuildingResult	build(ModelBuildingRequest request, ModelBuildingResult result)	Builds the effective model by completing the specified interim result which was produced by a previous call to build(ModelBuildingRequest) with ModelBuildingRequest.isTwoPhaseBuilding() being true.
Result<? extends Model>	buildRawModel(File pomFile, int validationLevel, boolean locationTracking)	Performs only the part of build(ModelBuildingRequest) that loads the raw model

Method Detail

build

ModelBuildingResult build(ModelBuildingRequest request)
                   throws ModelBuildingException

Builds the effective model of the specified POM.

Parameters:

request - The model building request that holds the parameters, must not be null.

Returns:

The result of the model building, never null.

Throws:

ModelBuildingException - If the effective model could not be built.

build

ModelBuildingResult build(ModelBuildingRequest request,
                          ModelBuildingResult result)
                   throws ModelBuildingException

Builds the effective model by completing the specified interim result which was produced by a previous call to build(ModelBuildingRequest) with ModelBuildingRequest.isTwoPhaseBuilding() being true. The model building request passed to this method must be the same as the one used for the first phase of the model building.

Parameters:

request - The model building request that holds the parameters, must not be null.

result - The interim result of the first phase of model building, must not be null.

Returns:

The result of the model building, never null.

Throws:

ModelBuildingException - If the effective model could not be built.

buildRawModel

Result<? extends Model> buildRawModel(File pomFile,
                                      int validationLevel,
                                      boolean locationTracking)

Performs only the part of build(ModelBuildingRequest) that loads the raw model