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 import java.io.File;
23
24 import org.apache.maven.model.Model;
25
26 /**
27 * Builds the effective model from a POM.
28 *
29 * @author Benjamin Bentmann
30 */
31 public interface ModelBuilder
32 {
33
34 /**
35 * Builds the effective model of the specified POM.
36 *
37 * @param request The model building request that holds the parameters, must not be {@code null}.
38 * @return The result of the model building, never {@code null}.
39 * @throws ModelBuildingException If the effective model could not be built.
40 */
41 ModelBuildingResult build( ModelBuildingRequest request )
42 throws ModelBuildingException;
43
44 /**
45 * Builds the effective model by completing the specified interim result which was produced by a previous call to
46 * {@link #build(ModelBuildingRequest)} with {@link ModelBuildingRequest#isTwoPhaseBuilding()} being {@code true}.
47 * The model building request passed to this method must be the same as the one used for the first phase of the
48 * model building.
49 *
50 * @param request The model building request that holds the parameters, must not be {@code null}.
51 * @param result The interim result of the first phase of model building, must not be {@code null}.
52 * @return The result of the model building, never {@code null}.
53 * @throws ModelBuildingException If the effective model could not be built.
54 */
55 ModelBuildingResult build( ModelBuildingRequest request, ModelBuildingResult result )
56 throws ModelBuildingException;
57
58 /**
59 * Performs only the part of {@link ModelBuilder#build(ModelBuildingRequest)} that loads the raw model
60 *
61 * @param request
62 * @return
63 * @throws ModelBuildingException
64 */
65 Result<? extends Model> buildRawModel( File pomFile, int validationLevel, boolean locationTracking );
66
67 }