Class TagValuesReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

org.nuiton.eugene.plugin.TagValuesReport

All Implemented Interfaces:

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

@Mojo(name="tag-values-report",
      requiresReports=true,
      requiresDependencyResolution=COMPILE)
public class TagValuesReport
extends org.apache.maven.reporting.AbstractMavenReport

To report a TagValueMetadatasProvider. Created on 5/31/14.

Since:

2.10

Author:

Tony Chemit - chemit@codelutin.com

Field Summary

Fields

Modifier and Type	Field	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 String	providerName	Name of the tagValue provider.
protected Map<String, org.nuiton.eugene.models.extension.tagvalue.provider.TagValueMetadatasProvider>	providers
protected org.apache.maven.doxia.siterenderer.Renderer	siteRenderer	Doxia Site Renderer component.
protected boolean	skip	Skip to generate the report.

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

locale, mojoExecution, outputFormat, outputTimestamp, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteTool

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	Description
TagValuesReport()

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateReport()
protected void	executeReport(Locale locale)
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
protected String	getOutputDirectory()
String	getOutputName()
protected org.apache.maven.project.MavenProject	getProject()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()

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

closeReport, constructXrefLocation, execute, generate, generate, getInputEncoding, getLocale, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, getXrefLocation, isExternalReport, setReportOutputDirectory

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.reporting.MavenReport

getOutputPath

Field Details

providerName

@Parameter(property="eugene.providerName",
           defaultValue="${project.artifactId}",
           required=true)
protected String providerName

Name of the tagValue provider. This is the role-hint given to the tag value provider to describe.

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.

providers

@Component(role=org.nuiton.eugene.models.extension.tagvalue.provider.TagValueMetadatasProvider.class)
protected Map<String, org.nuiton.eugene.models.extension.tagvalue.provider.TagValueMetadatasProvider> providers

Constructor Details

TagValuesReport

public TagValuesReport()

Method Details

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()

Overrides:

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

getOutputDirectory

protected String getOutputDirectory()

Overrides:

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

getProject

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

Overrides:

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

getOutputName

public String getOutputName()