Package org.apache.maven.reporting.exec
Class MavenReportExecution
java.lang.Object
org.apache.maven.reporting.exec.MavenReportExecution
Since Maven 3, reporting plugins (ie MavenReport
s) 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 theMavenReport
.
With this bean, a plugin wanting to generate a report (= "execute" the report) has to call the
method, setting the current invalid reference
MavenReport#generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)
Thread
classLoader first with classLoader
.
This bean is instantiated by MavenReportExecutor
.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate ClassLoader
private final String
private org.apache.maven.reporting.MavenReport
private org.apache.maven.model.Plugin
private boolean
-
Constructor Summary
ConstructorsConstructorDescriptionMavenReportExecution
(String goal, org.apache.maven.model.Plugin plugin, org.apache.maven.reporting.MavenReport mavenReport, ClassLoader classLoader, boolean userDefined) MavenReportExecution
(org.apache.maven.model.Plugin plugin, org.apache.maven.reporting.MavenReport mavenReport, ClassLoader classLoader, boolean userDefined) MavenReportExecution
(org.apache.maven.reporting.MavenReport mavenReport) -
Method Summary
Modifier and TypeMethodDescriptionboolean
execute Maven Report'scanGenerate()
with adequate classloader.getGoal()
org.apache.maven.reporting.MavenReport
org.apache.maven.model.Plugin
boolean
void
setClassLoader
(ClassLoader classLoader) void
setMavenReport
(org.apache.maven.reporting.MavenReport mavenReport) void
setPlugin
(org.apache.maven.model.Plugin plugin) void
setUserDefined
(boolean userDefined)
-
Field Details
-
goal
-
plugin
private org.apache.maven.model.Plugin plugin -
mavenReport
private org.apache.maven.reporting.MavenReport mavenReport -
classLoader
-
userDefined
private boolean userDefined
-
-
Constructor Details
-
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 Details
-
canGenerateReport
public boolean canGenerateReport() throws org.apache.maven.reporting.MavenReportExceptionexecute 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
-
setClassLoader
-
setPlugin
public void setPlugin(org.apache.maven.model.Plugin plugin) -
getPlugin
public org.apache.maven.model.Plugin getPlugin() -
getGoal
-
isUserDefined
public boolean isUserDefined() -
setUserDefined
public void setUserDefined(boolean userDefined)
-