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.validation;
20
21 import java.util.List;
22
23 import org.apache.maven.model.Model;
24 import org.apache.maven.model.Profile;
25 import org.apache.maven.model.building.ModelBuildingRequest;
26 import org.apache.maven.model.building.ModelProblemCollector;
27
28 /**
29 * Checks the model for missing or invalid values.
30 *
31 * @deprecated use {@link org.apache.maven.api.services.ModelBuilder} instead
32 */
33 @Deprecated(since = "4.0.0")
34 public interface ModelValidator {
35 /**
36 * Checks the specified file model for missing or invalid values. This model is directly created from the POM
37 * file and has not been subjected to inheritance, interpolation or profile/default injection.
38 *
39 * @param model The model to validate, must not be {@code null}.
40 * @param request The model building request that holds further settings, must not be {@code null}.
41 * @param problems The container used to collect problems that were encountered, must not be {@code null}.
42 */
43 default void validateFileModel(Model model, ModelBuildingRequest request, ModelProblemCollector problems) {
44 // do nothing
45 }
46
47 /**
48 * Checks the specified (raw) model for missing or invalid values. The raw model is the file model + buildpom filter
49 * transformation and has not been subjected to inheritance, interpolation or profile/default injection.
50 *
51 * @param model The model to validate, must not be {@code null}.
52 * @param request The model building request that holds further settings, must not be {@code null}.
53 * @param problems The container used to collect problems that were encountered, must not be {@code null}.
54 */
55 void validateRawModel(Model model, ModelBuildingRequest request, ModelProblemCollector problems);
56
57 /**
58 * Checks the specified (raw) model for clashes with the passed active external profiles. The raw model is the
59 * file model + buildpom filter transformation and has not been subjected to inheritance, interpolation or profile/default injection.
60 *
61 * @param activeExternalProfiles the active profiles coming from external sources (settings.xml), must not be {@code null}
62 * @param model The model to validate, must not be {@code null}.
63 * @param request The model building request that holds further settings, must not be {@code null}.
64 * @param problems The container used to collect problems that were encountered, must not be {@code null}.
65 * @since 4.0.0
66 */
67 default void validateExternalProfiles(
68 List<Profile> activeExternalProfiles,
69 Model model,
70 ModelBuildingRequest request,
71 ModelProblemCollector problems) {
72 // do nothing
73 }
74
75 /**
76 * Checks the specified (effective) model for missing or invalid values. The effective model is fully assembled and
77 * has undergone inheritance, interpolation and other model operations.
78 *
79 * @param model The model to validate, must not be {@code null}.
80 * @param request The model building request that holds further settings, must not be {@code null}.
81 * @param problems The container used to collect problems that were encountered, must not be {@code null}.
82 */
83 void validateEffectiveModel(Model model, ModelBuildingRequest request, ModelProblemCollector problems);
84 }