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 org.apache.maven.model.Model;
22 import org.apache.maven.model.building.ModelBuildingRequest;
23 import org.apache.maven.model.building.ModelProblemCollector;
24
25 /**
26 * Checks the model for missing or invalid values.
27 *
28 * @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a>
29 */
30 public interface ModelValidator {
31 /**
32 * Checks the specified file model for missing or invalid values. This model is directly created from the POM
33 * file and has not been subjected to inheritance, interpolation or profile/default injection.
34 *
35 * @param model The model to validate, must not be {@code null}.
36 * @param request The model building request that holds further settings, must not be {@code null}.
37 * @param problems The container used to collect problems that were encountered, must not be {@code null}.
38 */
39 default void validateFileModel(Model model, ModelBuildingRequest request, ModelProblemCollector problems) {
40 // do nothing
41 }
42
43 /**
44 * Checks the specified (raw) model for missing or invalid values. The raw model is the file model + buildpom filter
45 * transformation and has not been subjected to inheritance, interpolation or profile/default injection.
46 *
47 * @param model The model to validate, must not be {@code null}.
48 * @param request The model building request that holds further settings, must not be {@code null}.
49 * @param problems The container used to collect problems that were encountered, must not be {@code null}.
50 */
51 void validateRawModel(Model model, ModelBuildingRequest request, ModelProblemCollector problems);
52
53 /**
54 * Checks the specified (effective) model for missing or invalid values. The effective model is fully assembled and
55 * has undergone inheritance, interpolation and other model operations.
56 *
57 * @param model The model to validate, must not be {@code null}.
58 * @param request The model building request that holds further settings, must not be {@code null}.
59 * @param problems The container used to collect problems that were encountered, must not be {@code null}.
60 */
61 void validateEffectiveModel(Model model, ModelBuildingRequest request, ModelProblemCollector problems);
62 }