1 package org.apache.maven.reporting.exec; 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 java.util.List; 23 24 import org.apache.maven.plugin.MojoExecutionException; 25 26 /** 27 * This component will prepare {@link org.apache.maven.reporting.MavenReport}s for later generation. If a 28 * {@link org.apache.maven.reporting.MavenReport} needs to fork a goal or a lifecycle phase, this fork is executed. 29 * <p> 30 * Notice that Maven Reports are classical {@link org.apache.maven.plugin.Mojo Mojos} implementing the 31 * {@link org.apache.maven.reporting.MavenReport} interface: when used as reports, their <code>Mojo.execute()</code> 32 * method is not to be used but <code>MavenReport.generate()</code>. 33 * </p> 34 * 35 * @author Olivier Lamy 36 */ 37 public interface MavenReportExecutor 38 { 39 /** 40 * Build the {@link org.apache.maven.reporting.MavenReport}s, with associated forked executions if necessary. 41 * 42 * @param mavenReportExecutorRequest 43 * @return a list or prepared Maven report executions 44 * @throws MojoExecutionException 45 */ 46 List<MavenReportExecution> buildMavenReports( MavenReportExecutorRequest mavenReportExecutorRequest ) 47 throws MojoExecutionException; 48 }