Repository: maven Updated Branches: refs/heads/master c239f6ea6 -> d37fbf601
improve model building documentation Project: http://git-wip-us.apache.org/repos/asf/maven/repo Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/d37fbf60 Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/d37fbf60 Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/d37fbf60 Branch: refs/heads/master Commit: d37fbf60119a92f7f1fbcfcea0a37cd1e6f39046 Parents: c239f6e Author: Hervé Boutemy <hbout...@apache.org> Authored: Fri Dec 26 18:06:02 2014 +0100 Committer: Hervé Boutemy <hbout...@apache.org> Committed: Fri Dec 26 18:06:02 2014 +0100 ---------------------------------------------------------------------- .../model/building/DefaultModelBuilder.java | 20 ++++++++- maven-model-builder/src/site/apt/index.apt | 46 ++++++++++++++------ 2 files changed, 51 insertions(+), 15 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/maven/blob/d37fbf60/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuilder.java ---------------------------------------------------------------------- diff --git a/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuilder.java b/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuilder.java index 1e01a5a..53aea6b 100644 --- a/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuilder.java +++ b/maven-model-builder/src/main/java/org/apache/maven/model/building/DefaultModelBuilder.java @@ -231,10 +231,12 @@ public class DefaultModelBuilder public ModelBuildingResult build( ModelBuildingRequest request ) throws ModelBuildingException { + // phase 1 DefaultModelBuildingResult result = new DefaultModelBuildingResult(); DefaultModelProblemCollector problems = new DefaultModelProblemCollector( result ); + // profile activation DefaultProfileActivationContext profileActivationContext = getProfileActivationContext( request ); problems.setSource( "(external profiles)" ); @@ -254,6 +256,7 @@ public class DefaultModelBuilder profileActivationContext.setUserProperties( profileProps ); } + // read and validate raw model Model inputModel = readModel( request.getModelSource(), request.getPomFile(), request, problems ); problems.setRootModel( inputModel ); @@ -275,6 +278,7 @@ public class DefaultModelBuilder problems.setSource( tmpModel ); + // model normalization modelNormalizer.mergeDuplicates( tmpModel, request, problems ); profileActivationContext.setProjectProperties( tmpModel.getProperties() ); @@ -286,6 +290,7 @@ public class DefaultModelBuilder Map<String, Activation> interpolatedActivations = getProfileActivations( rawModel, false ); injectProfileActivations( tmpModel, interpolatedActivations ); + // profile injection for ( Profile activeProfile : activePomProfiles ) { profileInjector.injectProfile( tmpModel, activeProfile, request, problems ); @@ -354,6 +359,7 @@ public class DefaultModelBuilder problems.setSource( inputModel ); checkPluginVersions( lineage, request, problems ); + // inheritance assembly assembleInheritance( lineage, request, problems ); Model resultModel = resultData.getModel(); @@ -361,12 +367,14 @@ public class DefaultModelBuilder problems.setSource( resultModel ); problems.setRootModel( resultModel ); + // model interpolation resultModel = interpolateModel( resultModel, request, problems ); resultData.setModel( resultModel ); + // url normalization modelUrlNormalizer.normalize( resultModel, request ); - //Now the fully interpolated model is available reconfigure the resolver + // Now the fully interpolated model is available: reconfigure the resolver configureResolver( request.getModelResolver(), resultModel, problems , true ); resultData.setGroupId( resultModel.getGroupId() ); @@ -402,14 +410,17 @@ public class DefaultModelBuilder Collection<String> imports ) throws ModelBuildingException { + // phase 2 Model resultModel = result.getEffectiveModel(); DefaultModelProblemCollector problems = new DefaultModelProblemCollector( result ); problems.setSource( resultModel ); problems.setRootModel( resultModel ); + // model path translation modelPathTranslator.alignToBaseDirectory( resultModel, resultModel.getProjectDirectory(), request ); + // plugin management injection pluginManagementInjector.injectManagement( resultModel, request, problems ); fireEvent( resultModel, request, problems, ModelBuildingEventCatapult.BUILD_EXTENSIONS_ASSEMBLED ); @@ -421,24 +432,31 @@ public class DefaultModelBuilder throw new IllegalStateException( "lifecycle bindings injector is missing" ); } + // lifecycle bindings injection lifecycleBindingsInjector.injectLifecycleBindings( resultModel, request, problems ); } + // dependency management import importDependencyManagement( resultModel, request, problems, imports ); + // dependency management injection dependencyManagementInjector.injectManagement( resultModel, request, problems ); modelNormalizer.injectDefaultValues( resultModel, request, problems ); if ( request.isProcessPlugins() ) { + // reports configuration reportConfigurationExpander.expandPluginConfiguration( resultModel, request, problems ); + // reports conversion to decoupled site plugin reportingConverter.convertReporting( resultModel, request, problems ); + // plugins configuration pluginConfigurationExpander.expandPluginConfiguration( resultModel, request, problems ); } + // effective model validation modelValidator.validateEffectiveModel( resultModel, request, problems ); if ( hasModelErrors( problems ) ) http://git-wip-us.apache.org/repos/asf/maven/blob/d37fbf60/maven-model-builder/src/site/apt/index.apt ---------------------------------------------------------------------- diff --git a/maven-model-builder/src/site/apt/index.apt b/maven-model-builder/src/site/apt/index.apt index 43265dd..64cb805 100644 --- a/maven-model-builder/src/site/apt/index.apt +++ b/maven-model-builder/src/site/apt/index.apt @@ -35,23 +35,25 @@ Maven Model Builder {{{./xref/org/apache/maven/model/building/DefaultModelBuilder.html}source}}) that manages the steps sequence. - The sequence is divided into 2 phases, with optional plugin processing: + The sequence is divided into 2 phases: * phase 1 - ** raw model validation: <<<ModelValidator>>> ({{{./apidocs/org/apache/maven/model/validation/ModelValidator.html}javadoc}}), - with its <<<DefaultModelValidator>>> implementation - ({{{./xref/org/apache/maven/model/validation/DefaultModelValidator.html}source}}) - ** profile activation: see {{{./apidocs/org/apache/maven/model/profile/activation/package-summary.html}available activators}}. Notice that model interpolation hasn't happened yet, then interpolation for file-based activation is limited to <<<$\{basedir}>>> (since Maven 3), System properties and request properties - ** model normalization: <<<ModelNormalizer>>> ({{{./apidocs/org/apache/maven/model/normalization/ModelNormalizer.html}javadoc}}), + ** raw model validation: <<<ModelValidator>>> ({{{./apidocs/org/apache/maven/model/validation/ModelValidator.html}javadoc}}), + with its <<<DefaultModelValidator>>> implementation + ({{{./xref/org/apache/maven/model/validation/DefaultModelValidator.html}source}}) + + ** model normalization - merge duplicates: <<<ModelNormalizer>>> ({{{./apidocs/org/apache/maven/model/normalization/ModelNormalizer.html}javadoc}}), with its <<<DefaultModelNormalizer>>> implementation ({{{./xref/org/apache/maven/model/normalization/DefaultModelNormalizer.html}source}}) - ** profile injection + ** profile injection: <<<ProfileInjector>>> ({{{./apidocs/org/apache/maven/model/profile/ProfileInjector.html}javadoc}}), + with its <<<DefaultProfileInjector>>> implementation + ({{{./xref/org/apache/maven/model/profile/DefaultProfileInjector.html}source}}) ** parent resolution until {{{./super-pom.html}super-pom}} @@ -67,25 +69,41 @@ Maven Model Builder [] - * phase 2 + * phase 2, with optional plugin processing ** model path translation: <<<ModelPathTranslator>>> ({{{./apidocs/org/apache/maven/model/path/ModelPathTranslator.html}javadoc}}), with its <<<DefaultModelPathTranslator>>> implementation ({{{./xref/org/apache/maven/model/path/DefaultModelPathTranslator.html}source}}) - ** plugin management injection + ** plugin management injection: <<<PluginManagementInjector>>> ({{{./apidocs/org/apache/maven/model/management/PluginManagementInjector.html}javadoc}}), + with its <<<DefaultPluginManagementInjector>>> implementation + ({{{./xref/org/apache/maven/model/management/DefaultPluginManagementInjector.html}source}}) - ** <(optional)> lifecycle bindings injection + ** <(optional)> lifecycle bindings injection: <<<LifecycleBindingsInjector>>> ({{{./apidocs/org/apache/maven/model/plugin/LifecycleBindingsInjector.html}javadoc}}), + with its <<<DefaultLifecycleBindingsInjector>>> implementation + ({{{./xref/org/apache/maven/model/plugin/DefaultLifecycleBindingsInjector.html}source}}) ** dependency management import (for dependencies of type <<<pom>>> in the <<<\<dependencyManagement\>>>> section) - ** dependency management injection + ** dependency management injection: <<<DependencyManagementInjector>>> ({{{./apidocs/org/apache/maven/model/management/DependencyManagementInjector.html}javadoc}}), + with its <<<DefaultDependencyManagementInjector>>> implementation + ({{{./xref/org/apache/maven/model/management/DefaultDependencyManagementInjector.html}source}}) + + ** model normalization - inject default values: <<<ModelNormalizer>>> ({{{./apidocs/org/apache/maven/model/normalization/ModelNormalizer.html}javadoc}}), + with its <<<DefaultModelNormalizer>>> implementation + ({{{./xref/org/apache/maven/model/normalization/DefaultModelNormalizer.html}source}}) - ** <(optional)> reports configuration + ** <(optional)> reports configuration: <<<ReportConfigurationExpander>>> ({{{./apidocs/org/apache/maven/model/plugin/ReportConfigurationExpander.html}javadoc}}), + with its <<<DefaultReportConfigurationExpander>>> implementation + ({{{./xref/org/apache/maven/model/plugin/DefaultReportConfigurationExpander.html}source}}) - ** <(optional)> reports conversion to decoupled site plugin + ** <(optional)> reports conversion to decoupled site plugin: <<<ReportingConverter>>> ({{{./apidocs/org/apache/maven/model/plugin/ReportingConverter.html}javadoc}}), + with its <<<DefaultReportingConverter>>> implementation + ({{{./xref/org/apache/maven/model/plugin/DefaultReportingConverter.html}source}}) - ** <(optional)> plugins configuration + ** <(optional)> plugins configuration: <<<PluginConfigurationExpander>>> ({{{./apidocs/org/apache/maven/model/plugin/PluginConfigurationExpander.html}javadoc}}), + with its <<<DefaultPluginConfigurationExpander>>> implementation + ({{{./xref/org/apache/maven/model/plugin/DefaultPluginConfigurationExpander.html}source}}) ** effective model validation: <<<ModelValidator>>> ({{{./apidocs/org/apache/maven/model/validation/ModelValidator.html}javadoc}}), with its <<<DefaultModelValidator>>> implementation
