org.nuiton.eugene.plugin

Class AbstractEugeneReport<D>

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.nuiton.eugene.plugin.AbstractEugeneReport<D>

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport

Direct Known Subclasses:

StereotypesReport, TagValuesReport

public abstract class AbstractEugeneReport<D>
extends org.apache.maven.reporting.AbstractMavenReport

Abstract application config report used by normal and aggregate report.

Since:

2.10

Author:

Tony Chemit - chemit@codelutin.com

Field Summary

Fields

Modifier and Type	Field and Description
protected org.codehaus.plexus.i18n.I18N	i18n Internationalization component.
protected String	javaDocDestDir Location of javadoc report.
protected String	jxrDestDir Location of xref report.
protected File	outputDirectory Report output directory.
protected String	outputEncoding Report output encoding.
protected org.apache.maven.project.MavenProject	project The Maven Project.
protected org.apache.maven.doxia.siterenderer.Renderer	siteRenderer Doxia Site Renderer component.
protected boolean	skip Skip to generate the report.

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

Constructors

Constructor and Description
AbstractEugeneReport()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected abstract org.apache.maven.reporting.AbstractMavenReportRenderer	createRenderer(Locale locale, D data)
protected void	executeReport(Locale locale)
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
protected String	getOutputDirectory()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
protected abstract D	initData(Locale locale)

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

closeReport, execute, generate, generate, generate, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport, setReportOutputDirectory

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

getOutputName

Field Detail

outputDirectory

@Parameter(property="config.outputDirectory",
           defaultValue="${project.reporting.outputDirectory}",
           required=true)
protected File outputDirectory

Report output directory. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.

outputEncoding

@Parameter(property="config.outputEncoding",
           defaultValue="${project.reporting.outputEncoding}",
           required=true)
protected String outputEncoding

Report output encoding. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output encoding configured in the Maven Site Plugin is used instead.

skip

@Parameter(property="config.skip")
protected boolean skip

Skip to generate the report.

javaDocDestDir

@Parameter(property="eugene.javaDocDestDir",
           defaultValue="apidocs")
protected String javaDocDestDir

Location of javadoc report.

jxrDestDir

@Parameter(property="eugene.jxrDestDir",
           defaultValue="xref")
protected String jxrDestDir

Location of xref report.

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

The Maven Project.

siteRenderer

@Component
protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer

Doxia Site Renderer component.

i18n

@Component
protected org.codehaus.plexus.i18n.I18N i18n

Internationalization component.

Constructor Detail

AbstractEugeneReport

public AbstractEugeneReport()

Method Detail

createRenderer

protected abstract org.apache.maven.reporting.AbstractMavenReportRenderer createRenderer(Locale locale,
                                                                    D data)

initData

protected abstract D initData(Locale locale)
                       throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException

getDescription

public String getDescription(Locale locale)

getName

public String getName(Locale locale)

getCategoryName

public String getCategoryName()

Specified by:

getCategoryName in interface org.apache.maven.reporting.MavenReport

Overrides:

getCategoryName in class org.apache.maven.reporting.AbstractMavenReport

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

Overrides:

canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Specified by:

getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

getOutputDirectory

protected String getOutputDirectory()

Specified by:

getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

getProject

protected org.apache.maven.project.MavenProject getProject()

Specified by:

getProject in class org.apache.maven.reporting.AbstractMavenReport

executeReport

protected void executeReport(Locale locale)
                      throws org.apache.maven.reporting.MavenReportException

Specified by:

executeReport in class org.apache.maven.reporting.AbstractMavenReport

Throws:

org.apache.maven.reporting.MavenReportException