public abstract class AbstractMavenReport extends AbstractMojo implements MavenMultiPageReport
abstract executeReport( Locale )
from:
execute()
method, see maven-plugin-apigenerate( Sink, SinkFactory, Locale )
, see maven-reporting-apiMojo.execute()
, from maven-plugin-api
,
MavenMultiPageReport.generate( Sink, SinkFactory, Locale )
,
from maven-reporting-api
,
abstract executeReport( Locale )
Modifier and Type | Field and Description |
---|---|
protected File |
outputDirectory
The output directory for the report.
|
protected MavenProject |
project
The Maven Project.
|
protected org.apache.maven.doxia.siterenderer.Renderer |
siteRenderer
Doxia Site Renderer component.
|
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE
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(Sink sink,
Locale locale)
Deprecated.
use
generate(Sink, SinkFactory, Locale) instead. |
void |
generate(Sink sink,
Locale locale)
Deprecated.
use
generate(Sink, SinkFactory, Locale) instead. |
void |
generate(Sink sink,
SinkFactory sinkFactory,
Locale locale)
This method is called when the report generation is invoked by maven-site-plugin.
|
String |
getCategoryName() |
protected String |
getInputEncoding()
Gets the input files encoding.
|
protected String |
getOutputDirectory() |
protected String |
getOutputEncoding()
Gets the effective reporting output files encoding.
|
protected MavenProject |
getProject() |
File |
getReportOutputDirectory() |
Sink |
getSink() |
SinkFactory |
getSinkFactory() |
protected org.apache.maven.doxia.siterenderer.Renderer |
getSiteRenderer() |
boolean |
isExternalReport() |
void |
setReportOutputDirectory(File reportOutputDirectory) |
getLog, getPluginContext, setLog, setPluginContext
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getDescription, getName, getOutputName
@Parameter(defaultValue="${project.reporting.outputDirectory}", readonly=true, required=true) protected File outputDirectory
@Parameter(defaultValue="${project}", readonly=true, required=true) protected MavenProject project
@Component protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer
public void execute() throws MojoExecutionException
execute
in interface Mojo
MojoExecutionException
- if an error occurs when generating the reportplugins.site.ReportDocumentRender
,
Mojo.execute()
public void generate(Sink sink, Locale locale) throws MavenReportException
generate(Sink, SinkFactory, Locale)
instead.generate
in interface MavenReport
sink
- the sink to use for the generation.locale
- the wanted locale to generate the report, could be null.MavenReportException
- if anypublic void generate(Sink sink, Locale locale) throws MavenReportException
generate(Sink, SinkFactory, Locale)
instead.sink
- locale
- MavenReportException
org.apache.maven.reporting.MavenReport#generate(org.apache.maven.doxia.sink.Sink, java.util.Locale)
public void generate(Sink sink, SinkFactory sinkFactory, Locale locale) throws MavenReportException
generate
in interface MavenMultiPageReport
sink
- sinkFactory
- locale
- MavenReportException
public String getCategoryName()
getCategoryName
in interface MavenReport
public File getReportOutputDirectory()
getReportOutputDirectory
in interface MavenReport
public void setReportOutputDirectory(File reportOutputDirectory)
setReportOutputDirectory
in interface MavenReport
protected String getOutputDirectory()
protected MavenProject getProject()
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
protected String getInputEncoding()
null
.protected String getOutputEncoding()
null
.protected void closeReport()
public Sink getSink()
public SinkFactory getSinkFactory()
public boolean isExternalReport()
isExternalReport
in interface MavenReport
MavenReport.isExternalReport()
public boolean canGenerateReport()
canGenerateReport
in interface MavenReport
protected abstract void executeReport(Locale locale) throws MavenReportException
locale
- the wanted locale to return the report's description, could be null
.MavenReportException
- if anyCopyright © 2002–2017 The Apache Software Foundation. All rights reserved.