public abstract class AbstractMavenReport extends org.apache.maven.plugin.AbstractMojo implements MavenMultiPageReport
abstract executeReport( Locale )
:
Mojo.execute() (from maven-plugin-api)
,
MavenMultiPageReport.generate( Sink, SinkFactory, Locale ) (from maven-reporting-api)
,
abstract executeReport( Locale )
Constructor and Description |
---|
AbstractMavenReport() |
Modifier and Type | Method and Description |
---|---|
boolean |
canGenerateReport() |
protected void |
closeReport()
Actions when closing the report.
|
void |
execute()
This method is called when the report generation is invoked directly as a standalone Mojo.
|
protected abstract void |
executeReport(Locale locale)
Execute the generation of the report.
|
void |
generate(org.codehaus.doxia.sink.Sink aSink,
Locale aLocale)
Deprecated.
use
generate(Sink, SinkFactory, Locale) instead. |
void |
generate(org.apache.maven.doxia.sink.Sink aSink,
Locale aLocale)
Deprecated.
use
generate(Sink, SinkFactory, Locale) instead. |
void |
generate(org.apache.maven.doxia.sink.Sink aSink,
org.apache.maven.doxia.sink.SinkFactory aSinkFactory,
Locale aLocale)
This method is called when the report generation is invoked by maven-site-plugin.
|
String |
getCategoryName() |
protected abstract String |
getOutputDirectory()
The output directory when the mojo is run directly from the command line.
|
protected abstract org.apache.maven.project.MavenProject |
getProject() |
File |
getReportOutputDirectory() |
org.apache.maven.doxia.sink.Sink |
getSink() |
org.apache.maven.doxia.sink.SinkFactory |
getSinkFactory() |
protected abstract org.apache.maven.doxia.siterenderer.Renderer |
getSiteRenderer() |
boolean |
isExternalReport() |
void |
setReportOutputDirectory(File reportOutputDirectory) |
getLog, getPluginContext, setLog, setPluginContext
public void execute() throws org.apache.maven.plugin.MojoExecutionException
execute
in interface org.apache.maven.plugin.Mojo
org.apache.maven.plugin.MojoExecutionException
- if an error occurs when generating the reportorg.apache.maven.plugins.site.ReportDocumentRender
,
Mojo.execute()
public void generate(org.codehaus.doxia.sink.Sink aSink, Locale aLocale) throws org.apache.maven.reporting.MavenReportException
generate(Sink, SinkFactory, Locale)
instead.generate
in interface org.apache.maven.reporting.MavenReport
aSink
- the sink to use for the generation.aLocale
- the wanted locale to generate the report, could be null.MavenReportException
- if anypublic void generate(org.apache.maven.doxia.sink.Sink aSink, Locale aLocale) throws org.apache.maven.reporting.MavenReportException
generate(Sink, SinkFactory, Locale)
instead.aSink
- aLocale
- MavenReportException
org.apache.maven.reporting.MavenReport#generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)
public void generate(org.apache.maven.doxia.sink.Sink aSink, org.apache.maven.doxia.sink.SinkFactory aSinkFactory, Locale aLocale) throws org.apache.maven.reporting.MavenReportException
generate
in interface MavenMultiPageReport
aSink
- aSinkFactory
- aLocale
- MavenReportException
public String getCategoryName()
getCategoryName
in interface org.apache.maven.reporting.MavenReport
public File getReportOutputDirectory()
getReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
public void setReportOutputDirectory(File reportOutputDirectory)
setReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
protected void closeReport()
public org.apache.maven.doxia.sink.Sink getSink()
public org.apache.maven.doxia.sink.SinkFactory getSinkFactory()
public boolean isExternalReport()
isExternalReport
in interface org.apache.maven.reporting.MavenReport
MavenReport.isExternalReport()
public boolean canGenerateReport()
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
protected abstract org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
protected abstract String getOutputDirectory()
MavenReport.setReportOutputDirectory(java.io.File)
. In this case, the return
value of this method is irrelevant. Therefore, developers should always call getReportOutputDirectory()
to get the effective output directory for the report. The later method will eventually fallback to this method
if the mojo is not run as part of a site generation.protected abstract org.apache.maven.project.MavenProject getProject()
protected abstract void executeReport(Locale locale) throws org.apache.maven.reporting.MavenReportException
locale
- the wanted locale to return the report's description, could be null.MavenReportException
- if anyCopyright © 2002-2014 The Apache Software Foundation. All Rights Reserved.