org.apache.maven.reporting.exec

Class MavenReportExecution

java.lang.Object

org.apache.maven.reporting.exec.MavenReportExecution

public class MavenReportExecution
extends Object

Since Maven 3, reporting plugins (ie MavenReports) are not anymore prepared by Maven core. This class will store all necessary information for later MavenReport generation/execution:

• a MavenReport,
• the goal name associated to the report,
• the associated ClassLoader for the report generation,
• the Plugin associated to the MavenReport.

With this bean, a plugin wanting to generate a report (= "execute" the report) has to call the MavenReport.generate(org.apache.maven.doxia.sink.Sink, java.util.Locale) method, setting the current Thread classLoader first with classLoader.

This bean is instantiated by MavenReportExecutor.

Author:

Olivier Lamy

Constructor Summary

Constructors

Constructor and Description
MavenReportExecution(org.apache.maven.reporting.MavenReport mavenReport)
MavenReportExecution(org.apache.maven.model.Plugin plugin, org.apache.maven.reporting.MavenReport mavenReport, ClassLoader classLoader, boolean userDefined)
MavenReportExecution(String goal, org.apache.maven.model.Plugin plugin, org.apache.maven.reporting.MavenReport mavenReport, ClassLoader classLoader, boolean userDefined)

Method Summary

Modifier and Type	Method and Description
boolean	canGenerateReport() execute Maven Report's canGenerate() with adequate classloader.
ClassLoader	getClassLoader()
String	getGoal()
org.apache.maven.reporting.MavenReport	getMavenReport()
org.apache.maven.model.Plugin	getPlugin()
boolean	isUserDefined()
void	setClassLoader(ClassLoader classLoader)
void	setMavenReport(org.apache.maven.reporting.MavenReport mavenReport)
void	setPlugin(org.apache.maven.model.Plugin plugin)
void	setUserDefined(boolean userDefined)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MavenReportExecution

public MavenReportExecution(String goal,
                            org.apache.maven.model.Plugin plugin,
                            org.apache.maven.reporting.MavenReport mavenReport,
                            ClassLoader classLoader,
                            boolean userDefined)

MavenReportExecution

public MavenReportExecution(org.apache.maven.model.Plugin plugin,
                            org.apache.maven.reporting.MavenReport mavenReport,
                            ClassLoader classLoader,
                            boolean userDefined)

MavenReportExecution

public MavenReportExecution(org.apache.maven.reporting.MavenReport mavenReport)

Method Detail

canGenerateReport

public boolean canGenerateReport()
                          throws org.apache.maven.reporting.MavenReportException

execute Maven Report's canGenerate() with adequate classloader.

Returns:

Maven Report's canGenerate() result

Throws:

org.apache.maven.reporting.MavenReportException - if any

getMavenReport

public org.apache.maven.reporting.MavenReport getMavenReport()

setMavenReport

public void setMavenReport(org.apache.maven.reporting.MavenReport mavenReport)

getClassLoader

public ClassLoader getClassLoader()

setClassLoader

public void setClassLoader(ClassLoader classLoader)

setPlugin

public void setPlugin(org.apache.maven.model.Plugin plugin)

getPlugin

public org.apache.maven.model.Plugin getPlugin()

getGoal

public String getGoal()

isUserDefined

public boolean isUserDefined()

setUserDefined

public void setUserDefined(boolean userDefined)