View Javadoc

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&oslash;l</a>
30   * @version $Id: ModelValidator.java 800451 2009-08-03 16:20:06Z bentmann $
31   */
32  public interface ModelValidator
33  {
34  
35      /**
36       * Checks the specified (raw) model for missing or invalid values. The raw 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      void validateRawModel( Model model, ModelBuildingRequest request, ModelProblemCollector problems );
44  
45      /**
46       * Checks the specified (effective) model for missing or invalid values. The effective model is fully assembled and
47       * has undergone inheritance, interpolation and other model operations.
48       * 
49       * @param model The model to validate, must not be {@code null}.
50       * @param request The model building request that holds further settings, must not be {@code null}.
51       * @param problems The container used to collect problems that were encountered, must not be {@code null}.
52       */
53      void validateEffectiveModel( Model model, ModelBuildingRequest request, ModelProblemCollector problems );
54  
55  }