View Javadoc

1   package org.apache.maven.model.normalization;
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   * Handles normalization of a model. In this context, normalization is the process of producing a canonical
28   * representation for models that physically look different but are semantically equivalent.
29   * 
30   * @author Benjamin Bentmann
31   */
32  public interface ModelNormalizer
33  {
34  
35      /**
36       * Merges duplicate elements like multiple declarations of the same build plugin in the specified model.
37       * 
38       * @param model The model whose duplicate elements should be merged, must not be {@code null}.
39       * @param request The model building request that holds further settings, must not be {@code null}.
40       * @param problems The container used to collect problems that were encountered, must not be {@code null}.
41       */
42      void mergeDuplicates( Model model, ModelBuildingRequest request, ModelProblemCollector problems );
43  
44      /**
45       * Sets default values in the specified model that for technical reasons cannot be set directly in the Modello
46       * definition.
47       * 
48       * @param model The model in which to set the default values, must not be {@code null}.
49       * @param request The model building request that holds further settings, must not be {@code null}.
50       * @param problems The container used to collect problems that were encountered, must not be {@code null}.
51       */
52      void injectDefaultValues( Model model, ModelBuildingRequest request, ModelProblemCollector problems );
53  
54  }