Package org.apache.maven.reporting.exec
Class MavenReportExecution
- java.lang.Object
-
- org.apache.maven.reporting.exec.MavenReportExecution
-
public class MavenReportExecution extends java.lang.Object
Since Maven 3, reporting plugins (ie
MavenReport
s) are not anymore prepared by Maven core. This class will store all necessary information for laterMavenReport
generation/execution:- a
MavenReport
, - the goal name associated to the report,
- the associated
ClassLoader
for the report generation, - the
Plugin
associated to theMavenReport
.
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 currentThread
classLoader first withclassLoader
.This bean is instantiated by
MavenReportExecutor
. - a
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.ClassLoader
classLoader
private java.lang.String
goal
private org.apache.maven.reporting.MavenReport
mavenReport
private org.apache.maven.model.Plugin
plugin
private boolean
userDefined
-
Constructor Summary
Constructors Constructor Description MavenReportExecution(java.lang.String goal, org.apache.maven.model.Plugin plugin, org.apache.maven.reporting.MavenReport mavenReport, java.lang.ClassLoader classLoader, boolean userDefined)
MavenReportExecution(org.apache.maven.model.Plugin plugin, org.apache.maven.reporting.MavenReport mavenReport, java.lang.ClassLoader classLoader, boolean userDefined)
MavenReportExecution(org.apache.maven.reporting.MavenReport mavenReport)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canGenerateReport()
execute Maven Report'scanGenerate()
with adequate classloader.java.lang.ClassLoader
getClassLoader()
java.lang.String
getGoal()
org.apache.maven.reporting.MavenReport
getMavenReport()
org.apache.maven.model.Plugin
getPlugin()
boolean
isUserDefined()
void
setClassLoader(java.lang.ClassLoader classLoader)
void
setMavenReport(org.apache.maven.reporting.MavenReport mavenReport)
void
setPlugin(org.apache.maven.model.Plugin plugin)
void
setUserDefined(boolean userDefined)
-
-
-
Constructor Detail
-
MavenReportExecution
public MavenReportExecution(java.lang.String goal, org.apache.maven.model.Plugin plugin, org.apache.maven.reporting.MavenReport mavenReport, java.lang.ClassLoader classLoader, boolean userDefined)
-
MavenReportExecution
public MavenReportExecution(org.apache.maven.model.Plugin plugin, org.apache.maven.reporting.MavenReport mavenReport, java.lang.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'scanGenerate()
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 java.lang.ClassLoader getClassLoader()
-
setClassLoader
public void setClassLoader(java.lang.ClassLoader classLoader)
-
setPlugin
public void setPlugin(org.apache.maven.model.Plugin plugin)
-
getPlugin
public org.apache.maven.model.Plugin getPlugin()
-
getGoal
public java.lang.String getGoal()
-
isUserDefined
public boolean isUserDefined()
-
setUserDefined
public void setUserDefined(boolean userDefined)
-
-