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