|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
public abstract class AbstractMavenReport
The basis for a Maven report.
Field Summary |
---|
Fields inherited from interface org.apache.maven.reporting.MavenReport |
---|
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE |
Fields inherited from interface org.apache.maven.plugin.Mojo |
---|
ROLE |
Constructor Summary | |
---|---|
AbstractMavenReport()
|
Method Summary | |
---|---|
boolean |
canGenerateReport()
|
protected void |
closeReport()
Actions when closing the report. |
void |
execute()
This method should be never called - all reports are rendered by Maven site-plugin's |
protected abstract void |
executeReport(java.util.Locale locale)
Execute the generation of the report. |
void |
generate(org.codehaus.doxia.sink.Sink aSink,
java.util.Locale aLocale)
Deprecated. use generate(Sink, SinkFactory, Locale) instead. |
void |
generate(org.apache.maven.doxia.sink.Sink aSink,
java.util.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,
java.util.Locale aLocale)
Generate a report. |
java.lang.String |
getCategoryName()
|
protected abstract java.lang.String |
getOutputDirectory()
The output directory when the mojo is run directly from the command line. |
protected abstract 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 abstract org.apache.maven.doxia.siterenderer.Renderer |
getSiteRenderer()
|
boolean |
isExternalReport()
|
void |
setReportOutputDirectory(java.io.File reportOutputDirectory)
|
Methods inherited from class org.apache.maven.plugin.AbstractMojo |
---|
getLog, getPluginContext, setLog, setPluginContext |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.maven.reporting.MavenReport |
---|
getDescription, getName, getOutputName |
Constructor Detail |
---|
public AbstractMavenReport()
Method Detail |
---|
public void execute() throws org.apache.maven.plugin.MojoExecutionException
execute
in interface org.apache.maven.plugin.Mojo
org.apache.maven.plugin.MojoExecutionException
- alwaysorg.apache.maven.plugins.site.ReportDocumentRender
,
Mojo.execute()
public void generate(org.codehaus.doxia.sink.Sink aSink, java.util.Locale aLocale) throws MavenReportException
generate(Sink, SinkFactory, Locale)
instead.
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, java.util.Locale aLocale) throws MavenReportException
generate(Sink, SinkFactory, Locale)
instead.
generate
in interface MavenReport
aSink
- aLocale
-
MavenReportException
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, java.util.Locale aLocale) throws MavenReportException
aSink
- aSinkFactory
- aLocale
-
MavenReportException
public java.lang.String getCategoryName()
getCategoryName
in interface MavenReport
public java.io.File getReportOutputDirectory()
getReportOutputDirectory
in interface MavenReport
public void setReportOutputDirectory(java.io.File reportOutputDirectory)
setReportOutputDirectory
in interface 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 MavenReport
MavenReport.isExternalReport()
public boolean canGenerateReport()
canGenerateReport
in interface MavenReport
protected abstract org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
protected abstract java.lang.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(java.util.Locale locale) throws MavenReportException
locale
- the wanted locale to return the report's description, could be null.
MavenReportException
- if any
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |