View Javadoc
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.plugin;
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   * Handles conversion of the <code>&lt;reporting&gt;</code> section into the configuration of Maven Site Plugin 3.x,
27   * i.e. <code>reportPlugins</code> and <code>outputDirectory</code> parameters.
28   *
29   * @author Benjamin Bentmann
30   */
31  public interface ReportingConverter {
32  
33      /**
34       * Converts values from model's reporting section into the configuration for Maven Site Plugin 3.x.
35       *
36       * @param model The model whose reporting section should be converted, must not be <code>null</code>.
37       * @param request The model building request that holds further settings, must not be {@code null}.
38       * @param problems The container used to collect problems that were encountered, must not be {@code null}.
39       */
40      void convertReporting(Model model, ModelBuildingRequest request, ModelProblemCollector problems);
41  }