org.nuiton.eugene.plugin

Class TagValuesReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.reporting.AbstractMavenReport

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

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",
      requiresProject=true,
      requiresReports=true,
      requiresDependencyResolution=COMPILE)
public class TagValuesReport
extends AbstractEugeneReport<TagValueDefinitionProvider>

To report a TagValueDefinitionProvider.

Created on 5/31/14.

Since:

2.10

Author:

Tony Chemit - chemit@codelutin.com

Field Summary

Fields

Modifier and Type	Field and Description
protected String	providerName Name of the tagValue provider.
protected Map<String,TagValueDefinitionProvider>	providers

Fields inherited from class org.nuiton.eugene.plugin.AbstractEugeneReport

i18n, javaDocDestDir, jxrDestDir, outputDirectory, outputEncoding, project, siteRenderer, skip

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

Method Summary

Methods

Modifier and Type	Method and Description
protected TagValuesReportRenderer	createRenderer(Locale locale, TagValueDefinitionProvider data)
String	getOutputName()
protected TagValueDefinitionProvider	initData(Locale locale)

Methods inherited from class org.nuiton.eugene.plugin.AbstractEugeneReport

canGenerateReport, executeReport, getCategoryName, getDescription, getName, getOutputDirectory, getProject, getSiteRenderer

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

Field Detail

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.

providers

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

Constructor Detail

TagValuesReport

public TagValuesReport()

Method Detail

initData

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

Specified by:

initData in class AbstractEugeneReport<TagValueDefinitionProvider>

Throws:

org.apache.maven.reporting.MavenReportException

createRenderer

protected TagValuesReportRenderer createRenderer(Locale locale,
                                     TagValueDefinitionProvider data)

Specified by:

createRenderer in class AbstractEugeneReport<TagValueDefinitionProvider>

getOutputName

public String getOutputName()