View Javadoc

1   package org.apache.maven.model.building;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  /**
23   * Builds the effective model from a POM.
24   * 
25   * @author Benjamin Bentmann
26   */
27  public interface ModelBuilder
28  {
29  
30      /**
31       * Builds the effective model of the specified POM.
32       * 
33       * @param request The model building request that holds the parameters, must not be {@code null}.
34       * @return The result of the model building, never {@code null}.
35       * @throws ModelBuildingException If the effective model could not be built.
36       */
37      ModelBuildingResult build( ModelBuildingRequest request )
38          throws ModelBuildingException;
39  
40      /**
41       * Builds the effective model by completing the specified interim result which was produced by a previous call to
42       * {@link #build(ModelBuildingRequest)} with {@link ModelBuildingRequest#isTwoPhaseBuilding()} being {@code true}.
43       * The model building request passed to this method must be the same as the one used for the first phase of the
44       * model building.
45       * 
46       * @param request The model building request that holds the parameters, must not be {@code null}.
47       * @param result The interim result of the first phase of model building, must not be {@code null}.
48       * @return The result of the model building, never {@code null}.
49       * @throws ModelBuildingException If the effective model could not be built.
50       */
51      ModelBuildingResult build( ModelBuildingRequest request, ModelBuildingResult result )
52          throws ModelBuildingException;
53  
54  }