public abstract class AbstractMavenReport
extends org.apache.maven.plugin.AbstractMojo
implements org.apache.maven.reporting.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 |
---|---|
private java.lang.String |
inputEncoding
Specifies the input encoding.
|
protected java.io.File |
outputDirectory
The output directory for the report.
|
private java.lang.String |
outputEncoding
Specifies the output encoding.
|
protected org.apache.maven.project.MavenProject |
project
The Maven Project.
|
private java.io.File |
reportOutputDirectory
The current report output directory to use
|
private org.apache.maven.doxia.sink.Sink |
sink
The current sink to use
|
private org.apache.maven.doxia.sink.SinkFactory |
sinkFactory
The sink factory to use
|
protected org.apache.maven.doxia.siterenderer.Renderer |
siteRenderer
Doxia Site Renderer component.
|
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(java.util.Locale locale)
Execute the generation of the report.
|
void |
generate(org.codehaus.doxia.sink.Sink sink,
java.util.Locale locale)
Deprecated.
use
generate(Sink, SinkFactory, Locale) instead. |
void |
generate(org.apache.maven.doxia.sink.Sink sink,
java.util.Locale locale)
Deprecated.
use
generate(Sink, SinkFactory, Locale) instead. |
void |
generate(org.apache.maven.doxia.sink.Sink sink,
org.apache.maven.doxia.sink.SinkFactory sinkFactory,
java.util.Locale locale)
This method is called when the report generation is invoked by maven-site-plugin.
|
java.lang.String |
getCategoryName() |
protected java.lang.String |
getInputEncoding()
Gets the input files encoding.
|
protected java.lang.String |
getOutputDirectory() |
protected java.lang.String |
getOutputEncoding()
Gets the effective reporting output files encoding.
|
protected org.apache.maven.project.MavenProject |
getProject() |
java.io.File |
getReportOutputDirectory() |
org.apache.maven.doxia.sink.Sink |
getSink() |
org.apache.maven.doxia.sink.SinkFactory |
getSinkFactory() |
protected org.apache.maven.doxia.siterenderer.Renderer |
getSiteRenderer() |
private java.util.Map<java.lang.String,java.lang.Object> |
getTemplateProperties()
create template properties like done in maven-site-plugin's
AbstractSiteRenderingMojo.createSiteRenderingContext( Locale ) |
boolean |
isExternalReport() |
void |
setReportOutputDirectory(java.io.File reportOutputDirectory) |
getLog, getPluginContext, setLog, setPluginContext
@Parameter(defaultValue="${project.reporting.outputDirectory}", readonly=true, required=true) protected java.io.File outputDirectory
@Parameter(defaultValue="${project}", readonly=true, required=true) protected org.apache.maven.project.MavenProject project
@Parameter(property="encoding", defaultValue="${project.build.sourceEncoding}", readonly=true) private java.lang.String inputEncoding
@Parameter(property="outputEncoding", defaultValue="${project.reporting.outputEncoding}", readonly=true) private java.lang.String outputEncoding
@Component protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer
private org.apache.maven.doxia.sink.Sink sink
private org.apache.maven.doxia.sink.SinkFactory sinkFactory
private java.io.File reportOutputDirectory
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()
private java.util.Map<java.lang.String,java.lang.Object> getTemplateProperties()
AbstractSiteRenderingMojo.createSiteRenderingContext( Locale )
public void generate(org.codehaus.doxia.sink.Sink sink, java.util.Locale locale) throws org.apache.maven.reporting.MavenReportException
generate(Sink, SinkFactory, Locale)
instead.generate
in interface org.apache.maven.reporting.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(org.apache.maven.doxia.sink.Sink sink, java.util.Locale locale) throws org.apache.maven.reporting.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(org.apache.maven.doxia.sink.Sink sink, org.apache.maven.doxia.sink.SinkFactory sinkFactory, java.util.Locale locale) throws org.apache.maven.reporting.MavenReportException
generate
in interface org.apache.maven.reporting.MavenMultiPageReport
sink
- sinkFactory
- locale
- MavenReportException
public java.lang.String getCategoryName()
getCategoryName
in interface org.apache.maven.reporting.MavenReport
public java.io.File getReportOutputDirectory()
getReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
public void setReportOutputDirectory(java.io.File reportOutputDirectory)
setReportOutputDirectory
in interface org.apache.maven.reporting.MavenReport
protected java.lang.String getOutputDirectory()
protected org.apache.maven.project.MavenProject getProject()
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
protected java.lang.String getInputEncoding()
null
.protected java.lang.String getOutputEncoding()
null
.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 void executeReport(java.util.Locale locale) throws org.apache.maven.reporting.MavenReportException
locale
- the wanted locale to return the report's description, could be null
.MavenReportException
- if any