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 import java.nio.file.Path;
23
24 import org.apache.maven.model.Model;
25
26 /**
27 * Builds the effective model from a POM.
28 *
29 * @deprecated use {@link org.apache.maven.api.services.ModelBuilder} instead
30 */
31 @Deprecated(since = "4.0.0")
32 public interface ModelBuilder {
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) throws ModelBuildingException;
42
43 /**
44 * Builds the effective model by completing the specified interim result which was produced by a previous call to
45 * {@link #build(ModelBuildingRequest)} with {@link ModelBuildingRequest#isTwoPhaseBuilding()} being {@code true}.
46 * The model building request passed to this method must be the same as the one used for the first phase of the
47 * model building.
48 *
49 * @param request The model building request that holds the parameters, must not be {@code null}.
50 * @param result The interim result of the first phase of model building, must not be {@code null}.
51 * @return The result of the model building, never {@code null}.
52 * @throws ModelBuildingException If the effective model could not be built.
53 */
54 ModelBuildingResult build(ModelBuildingRequest request, ModelBuildingResult result) throws ModelBuildingException;
55
56 /**
57 * Performs only the part of {@link ModelBuilder#build(ModelBuildingRequest)} that loads the raw model
58 *
59 * @deprecated Use {@link #buildRawModel(Path, int, boolean)} instead.
60 */
61 @Deprecated
62 Result<? extends Model> buildRawModel(File pomFile, int validationLevel, boolean locationTracking);
63
64 /**
65 * Performs only the part of {@link ModelBuilder#build(ModelBuildingRequest)} that loads the raw model
66 *
67 * @since 4.0.0
68 */
69 Result<? extends Model> buildRawModel(Path pomFile, int validationLevel, boolean locationTracking);
70
71 /**
72 * @deprecated Use {@link #buildRawModel(Path, int, boolean, TransformerContext)} instead.
73 */
74 @Deprecated
75 Result<? extends Model> buildRawModel(
76 File pomFile, int validationLevel, boolean locationTracking, TransformerContext context);
77
78 /**
79 * @since 4.0.0
80 */
81 Result<? extends Model> buildRawModel(
82 Path pomFile, int validationLevel, boolean locationTracking, TransformerContext context);
83
84 TransformerContextBuilder newTransformerContextBuilder();
85 }