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