001package org.apache.maven.model.plugin;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.maven.model.Model;
023import org.apache.maven.model.building.ModelBuildingRequest;
024import org.apache.maven.model.building.ModelProblemCollector;
025
026/**
027 * Handles conversion of the legacy reporting section into the configuration of the new Maven Site Plugin.
028 *
029 * @author Benjamin Bentmann
030 */
031public interface ReportingConverter
032{
033
034    /**
035     * Converts values from model's reporting section into the configuration for the new Maven Site Plugin.
036     *
037     * @param model The model whose reporting section should be converted, must not be <code>null</code>.
038     * @param request The model building request that holds further settings, must not be {@code null}.
039     * @param problems The container used to collect problems that were encountered, must not be {@code null}.
040     */
041    void convertReporting( Model model, ModelBuildingRequest request, ModelProblemCollector problems );
042
043}