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-apiModifier and Type | Field and Description |
---|---|
protected String |
locale
The locale to use when the report generation is invoked directly as a standalone Mojo.
|
protected org.apache.maven.artifact.repository.ArtifactRepository |
localRepository
The local repository.
|
protected File |
outputDirectory
The output directory for the report.
|
protected org.apache.maven.project.MavenProject |
project
The Maven Project.
|
protected List<org.apache.maven.artifact.repository.ArtifactRepository> |
remoteRepositories
Remote repositories used for the project.
|
protected org.apache.maven.doxia.siterenderer.Renderer |
siteRenderer
Doxia Site Renderer component.
|
protected org.apache.maven.doxia.tools.SiteTool |
siteTool
SiteTool.
|
protected org.apache.maven.doxia.site.decoration.Skin |
skin
The skin to use when the report generation is invoked directly as a standalone Mojo.
|
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.apache.maven.doxia.sink.Sink sink,
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,
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 Locale |
getLocale()
Gets the locale
|
protected String |
getOutputDirectory() |
protected String |
getOutputEncoding()
Gets the effective reporting output files encoding.
|
protected org.apache.maven.project.MavenProject |
getProject() |
File |
getReportOutputDirectory() |
org.apache.maven.doxia.sink.Sink |
getSink() |
org.apache.maven.doxia.sink.SinkFactory |
getSinkFactory() |
protected org.apache.maven.doxia.siterenderer.Renderer |
getSiteRenderer() |
protected org.apache.maven.doxia.site.decoration.Skin |
getSkin()
Gets the skin
|
boolean |
isExternalReport() |
void |
setReportOutputDirectory(File reportOutputDirectory) |
getLog, getPluginContext, setLog, setPluginContext
@Parameter(defaultValue="${project.reporting.outputDirectory}", readonly=true, required=true) protected File outputDirectory
@Parameter(defaultValue="${project}", readonly=true, required=true) protected org.apache.maven.project.MavenProject project
@Parameter(defaultValue="${localRepository}", readonly=true, required=true) protected org.apache.maven.artifact.repository.ArtifactRepository localRepository
@Parameter(defaultValue="${project.remoteArtifactRepositories}", readonly=true, required=true) protected List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositories
@Parameter protected org.apache.maven.doxia.site.decoration.Skin skin
Default value is:
<skin> <groupId>org.apache.maven.skins</groupId> <artifactId>maven-fluido-skin</artifactId> <version>1.11.1</version> </skin>
Skin
@Parameter(defaultValue="default") protected String locale
Default value is: SiteTool.DEFAULT_LOCALE
SiteTool.getSiteLocales(String)
@Component protected org.apache.maven.doxia.tools.SiteTool siteTool
@Component protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer
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 reportMojo.execute()
@Deprecated public void generate(org.apache.maven.doxia.sink.Sink sink, 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, org.apache.maven.doxia.sink.SinkFactory sinkFactory, Locale locale) throws org.apache.maven.reporting.MavenReportException
generate
in interface org.apache.maven.reporting.MavenMultiPageReport
sink
- sinkFactory
- locale
- 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 String getOutputDirectory()
protected org.apache.maven.project.MavenProject getProject()
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
protected String getInputEncoding()
null
.protected String getOutputEncoding()
null
.protected org.apache.maven.doxia.site.decoration.Skin getSkin()
protected Locale getLocale()
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
false
by default.MavenReport.isExternalReport()
public boolean canGenerateReport()
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
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–2022 The Apache Software Foundation. All rights reserved.