1 package org.apache.maven.model.plugin;
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 conversion of the <code><reporting></code> section into the configuration of Maven Site Plugin 3.x,
28 * i.e. <code>reportPlugins</code> and <code>outputDirectory</code> parameters.
29 *
30 * @author Benjamin Bentmann
31 */
32 public interface ReportingConverter
33 {
34
35 /**
36 * Converts values from model's reporting section into the configuration for Maven Site Plugin 3.x.
37 *
38 * @param model The model whose reporting section should be converted, must not be <code>null</code>.
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 convertReporting( Model model, ModelBuildingRequest request, ModelProblemCollector problems );
43
44 }