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